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

Merged
merged 1 commit into from
Apr 21, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions drivers/USBCDC_ECM.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
* \defgroup drivers_USBCDC_ECM USBCDC_ECM class
* \ingroup drivers-public-api-usb
* @{
* @note Bare metal profile: This class is not supported.
*/

class USBCDC_ECM: public USBDevice {
Expand Down
2 changes: 2 additions & 0 deletions rtos/ConditionVariable.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ struct Waiter;
*
* @note Synchronization level: Thread safe
*
* @note Bare metal profile: This class is not supported.
*
* Example:
*
* @code
Expand Down
3 changes: 3 additions & 0 deletions rtos/Mail.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ namespace rtos {
* Memory considerations: The mail data store and control structures are part of this class - they do not (themselves)
* allocate memory on the heap, both for the Mbed OS and underlying RTOS objects (static or dynamic RTOS memory
* pools are not being used).
*
* @note
* Bare metal profile: This class is not supported.
*/
template<typename T, uint32_t queue_sz>
class Mail : private mbed::NonCopyable<Mail<T, queue_sz> > {
Expand Down
3 changes: 3 additions & 0 deletions rtos/MemoryPool.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ namespace rtos {
@note
Memory considerations: The memory pool data store and control structures will be created on current thread's stack,
both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).

@note
Bare metal profile: This class is not supported.
*/
template<typename T, uint32_t pool_sz>
class MemoryPool : private mbed::NonCopyable<MemoryPool<T, pool_sz> > {
Expand Down
1 change: 1 addition & 0 deletions rtos/Queue.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ namespace rtos {
* current thread's stack, both for the Mbed OS and underlying RTOS
* objects (static or dynamic RTOS memory pools are not being used).
*
* @note Bare metal profile: This class is not supported.
*/
template<typename T, uint32_t queue_sz>
class Queue : private mbed::NonCopyable<Queue<T, queue_sz> > {
Expand Down
3 changes: 3 additions & 0 deletions rtos/Thread.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ namespace rtos {
* to give access to particular thread used overloaded constructor with `tz_module` as argument during thread creation.
*
* MBED_TZ_DEFAULT_ACCESS is target specific define, should be set in targets.json file for Cortex-M23/M33 devices.
*
* @note
* Bare metal profile: This class is not supported.
*/

class Thread : private mbed::NonCopyable<Thread> {
Expand Down