Skip to content

Add the Doxygen note to non-supported RTOS and Driver class. #12818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 21, 2020
Merged

Add the Doxygen note to non-supported RTOS and Driver class. #12818

merged 1 commit into from
Apr 21, 2020

Conversation

rajkan01
Copy link
Contributor

@rajkan01 rajkan01 commented Apr 16, 2020 •
edited
Loading

Summary of changes

Added the Doxygen note for below non-supported RTOS and Driver class in bare metal profile

  • USBCDC_ECM
  • ConditionVariable
  • Mail
  • MemoryPool
  • Queue
  • Thread

Impact of changes

With these changes, "Baremetal profile: This class is not supported" Doxygen note will be visible in the RTOS and driver class documentation for those non-supported in baremetal.

Migration actions required

None.

Documentation

None.

Pull request type 

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results 

[x] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@evedon

@mergify mergify bot added the needs: work label Apr 16, 2020
@ciarmcom ciarmcom requested review from evedon and a team April 16, 2020 15:00
@ciarmcom
Copy link
Member

@rajkan01, thank you for your changes.
@evedon @ARMmbed/mbed-os-core @ARMmbed/mbed-os-maintainers please review.

@rajkan01 rajkan01 force-pushed the rtos_driver_doxygen_note branch from 3af48f1 to c6e649f Compare April 16, 2020 15:37
ladislas
ladislas reviewed Apr 16, 2020
View reviewed changes
0xc0170
0xc0170 previously approved these changes Apr 17, 2020
View reviewed changes
@mergify mergify bot added needs: CI and removed needs: review labels Apr 17, 2020
@0xc0170
Copy link
Contributor

0xc0170 commented Apr 17, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Apr 17, 2020

Test run: SUCCESS

Summary: 6 of 6 test jobs passed
Build number : 1
Build artifacts

evedon
evedon previously requested changes Apr 20, 2020
View reviewed changes
@rajkan01 rajkan01 force-pushed the rtos_driver_doxygen_note branch from c6e649f to 9b2cea7 Compare April 20, 2020 17:25
@mergify mergify bot dismissed stale reviews from 0xc0170 and evedon April 20, 2020 17:25

Pull request has been modified.

@mergify mergify bot added the needs: CI label Apr 20, 2020
@mergify mergify bot removed the needs: work label Apr 20, 2020
@rajkan01
Copy link
Contributor Author

@0xc0170 Please start the CI

@0xc0170
Copy link
Contributor

0xc0170 commented Apr 21, 2020

CI started

@mbed-ci
Copy link

mbed-ci commented Apr 21, 2020

Test run: SUCCESS

Summary: 6 of 6 test jobs passed
Build number : 2
Build artifacts

@0xc0170 0xc0170 merged commit 31e3305 into ARMmbed:master Apr 21, 2020
@mergify mergify bot removed the ready for merge label Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ladislas ladislas ladislas left review comments

@0xc0170 0xc0170 0xc0170 approved these changes

@evedon evedon evedon approved these changes

Assignees
No one assigned
Labels
release-version: 6.0.0-beta-1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@rajkan01 @ciarmcom @0xc0170 @mbed-ci @ladislas @evedon