ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[platform] Update doxygen errors from @Note to @note

pull/4233/head
Sam Grove 2017-04-25 14:37:08 -05:00
parent 0b5b6cba71
commit 5e7ce5fa23
13 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
platform/CThunk.h
View File

@ -77,7 +77,7 @@ typedef void (*CThunkEntry)(void);
/** /**
* Class for created a pointer with data bound to it * Class for created a pointer with data bound to it
* *
* @Note Synchronization level: Not protected * @note Synchronization level: Not protected
* @ingroup platform * @ingroup platform
*/ */
template<class T> template<class T>

2
platform/CallChain.h
View File

@ -27,7 +27,7 @@ namespace mbed {
* sequence using CallChain::call(). Used mostly by the interrupt chaining code, * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
* but can be used for other purposes. * but can be used for other purposes.
* *
* @Note Synchronization level: Not protected * @note Synchronization level: Not protected
* *
* Example: * Example:
* @code * @code

2
platform/CircularBuffer.h
View File

@ -23,7 +23,7 @@ namespace mbed {
/** Templated Circular buffer class /** Templated Circular buffer class
* *
* @Note Synchronization level: Interrupt safe * @note Synchronization level: Interrupt safe
* @ingroup platform * @ingroup platform
*/ */
template<typename T, uint32_t BufferSize, typename CounterType = uint32_t> template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>

2
platform/DirHandle.h
View File

@ -38,7 +38,7 @@ namespace mbed {
* reflect this. * reflect this.
* *
* @note to create a directory, @see Dir * @note to create a directory, @see Dir
* @Note Synchronization level: Set by subclass * @note Synchronization level: Set by subclass
* @ingroup platform * @ingroup platform
*/ */
class DirHandle { class DirHandle {

2
platform/FileLike.h
View File

@ -28,7 +28,7 @@ namespace mbed {
* A file-like object is one that can be opened with fopen by * A file-like object is one that can be opened with fopen by
* fopen("/name", mode). * fopen("/name", mode).
* *
* @Note Synchronization level: Set by subclass * @note Synchronization level: Set by subclass
* @ingroup platform * @ingroup platform
*/ */
class FileLike : public FileHandle, public FileBase { class FileLike : public FileHandle, public FileBase {

2
platform/FileSystemLike.h
View File

@ -31,7 +31,7 @@ namespace mbed {
* Implementations must define at least open (the default definitions * Implementations must define at least open (the default definitions
* of the rest of the functions just return error values). * of the rest of the functions just return error values).
* *
* @Note Synchronization level: Set by subclass * @note Synchronization level: Set by subclass
* @ingroup platform * @ingroup platform
*/ */
class FileSystemLike : public FileBase { class FileSystemLike : public FileBase {

2
platform/LocalFileSystem.h
View File

@ -67,7 +67,7 @@ protected:
* mbed Microcontroller. Once created, the standard C file access functions are used to open, * mbed Microcontroller. Once created, the standard C file access functions are used to open,
* read and write files. * read and write files.
* *
* @Note Synchronization level: Thread safe * @note Synchronization level: Thread safe
* *
* Example: * Example:
* @code * @code

6
platform/SingletonPtr.h
View File

@ -59,13 +59,13 @@ inline static void singleton_unlock(void)
/** Utility class for creating an using a singleton /** Utility class for creating an using a singleton
* *
* @Note Synchronization level: Thread safe * @note Synchronization level: Thread safe
* *
* @Note: This class must only be used in a static context - * @note: This class must only be used in a static context -
* this class must never be allocated or created on the * this class must never be allocated or created on the
* stack. * stack.
* *
* @Note: This class is lazily initialized on first use. * @note: This class is lazily initialized on first use.
* This class is a POD type so if it is not used it will * This class is a POD type so if it is not used it will
* be garbage collected. * be garbage collected.
* @ingroup platform * @ingroup platform

2
platform/Stream.h
View File

@ -32,7 +32,7 @@ extern char* mbed_gets(char *s, int size, FILE *_file);
/** File stream /** File stream
* *
* @Note Synchronization level: Set by subclass * @note Synchronization level: Set by subclass
* @ingroup platform * @ingroup platform
*/ */
class Stream : public FileLike { class Stream : public FileLike {

2
platform/Transaction.h
View File

@ -37,7 +37,7 @@ typedef struct {
/** Transaction class defines a transaction. /** Transaction class defines a transaction.
* *
* @Note Synchronization level: Not protected * @note Synchronization level: Not protected
* @ingroup platform * @ingroup platform
*/ */
template<typename Class> template<typename Class>

22
platform/mbed_critical.h
View File

@ -33,7 +33,7 @@ extern "C" {
/** Determine the current interrupts enabled state /** Determine the current interrupts enabled state
* *
* This function can be called to determine whether or not interrupts are currently enabled. * This function can be called to determine whether or not interrupts are currently enabled.
* \note * @note
* NOTE: * NOTE:
* This function works for both cortex-A and cortex-M, although the underlyng implementation * This function works for both cortex-A and cortex-M, although the underlyng implementation
* differs. * differs.
@ -44,7 +44,7 @@ bool core_util_are_interrupts_enabled(void);
/** Mark the start of a critical section /** Mark the start of a critical section
* *
* This function should be called to mark the start of a critical section of code. * This function should be called to mark the start of a critical section of code.
* \note * @note
* NOTES: * NOTES:
* 1) The use of this style of critical section is targetted at C based implementations. * 1) The use of this style of critical section is targetted at C based implementations.
* 2) These critical sections can be nested. * 2) These critical sections can be nested.
@ -57,7 +57,7 @@ void core_util_critical_section_enter(void);
/** Mark the end of a critical section /** Mark the end of a critical section
* *
* This function should be called to mark the end of a critical section of code. * This function should be called to mark the end of a critical section of code.
* \note * @note
* NOTES: * NOTES:
* 1) The use of this style of critical section is targetted at C based implementations. * 1) The use of this style of critical section is targetted at C based implementations.
* 2) These critical sections can be nested. * 2) These critical sections can be nested.
@ -82,7 +82,7 @@ void core_util_critical_section_exit(void);
* @param[in,out] expectedCurrentValue A pointer to some location holding the * @param[in,out] expectedCurrentValue A pointer to some location holding the
* expected current value of the data being set atomically. * expected current value of the data being set atomically.
* The computed 'desiredValue' should be a function of this current value. * The computed 'desiredValue' should be a function of this current value.
* @Note: This is an in-out parameter. In the * @note: This is an in-out parameter. In the
* failure case of atomic_cas (where the * failure case of atomic_cas (where the
* destination isn't set), the pointee of expectedCurrentValue is * destination isn't set), the pointee of expectedCurrentValue is
* updated with the current value. * updated with the current value.
@ -105,7 +105,7 @@ void core_util_critical_section_exit(void);
* return true * return true
* } * }
* *
* @Note: In the failure case (where the destination isn't set), the value * @note: In the failure case (where the destination isn't set), the value
* pointed to by expectedCurrentValue is still updated with the current value. * pointed to by expectedCurrentValue is still updated with the current value.
* This property helps writing concise code for the following incr: * This property helps writing concise code for the following incr:
* *
@ -135,7 +135,7 @@ bool core_util_atomic_cas_u8(uint8_t *ptr, uint8_t *expectedCurrentValue, uint8_
* @param[in,out] expectedCurrentValue A pointer to some location holding the * @param[in,out] expectedCurrentValue A pointer to some location holding the
* expected current value of the data being set atomically. * expected current value of the data being set atomically.
* The computed 'desiredValue' should be a function of this current value. * The computed 'desiredValue' should be a function of this current value.
* @Note: This is an in-out parameter. In the * @note: This is an in-out parameter. In the
* failure case of atomic_cas (where the * failure case of atomic_cas (where the
* destination isn't set), the pointee of expectedCurrentValue is * destination isn't set), the pointee of expectedCurrentValue is
* updated with the current value. * updated with the current value.
@ -158,7 +158,7 @@ bool core_util_atomic_cas_u8(uint8_t *ptr, uint8_t *expectedCurrentValue, uint8_
* return true * return true
* } * }
* *
* @Note: In the failure case (where the destination isn't set), the value * @note: In the failure case (where the destination isn't set), the value
* pointed to by expectedCurrentValue is still updated with the current value. * pointed to by expectedCurrentValue is still updated with the current value.
* This property helps writing concise code for the following incr: * This property helps writing concise code for the following incr:
* *
@ -188,7 +188,7 @@ bool core_util_atomic_cas_u16(uint16_t *ptr, uint16_t *expectedCurrentValue, uin
* @param[in,out] expectedCurrentValue A pointer to some location holding the * @param[in,out] expectedCurrentValue A pointer to some location holding the
* expected current value of the data being set atomically. * expected current value of the data being set atomically.
* The computed 'desiredValue' should be a function of this current value. * The computed 'desiredValue' should be a function of this current value.
* @Note: This is an in-out parameter. In the * @note: This is an in-out parameter. In the
* failure case of atomic_cas (where the * failure case of atomic_cas (where the
* destination isn't set), the pointee of expectedCurrentValue is * destination isn't set), the pointee of expectedCurrentValue is
* updated with the current value. * updated with the current value.
@ -211,7 +211,7 @@ bool core_util_atomic_cas_u16(uint16_t *ptr, uint16_t *expectedCurrentValue, uin
* return true * return true
* } * }
* *
* @Note: In the failure case (where the destination isn't set), the value * @note: In the failure case (where the destination isn't set), the value
* pointed to by expectedCurrentValue is still updated with the current value. * pointed to by expectedCurrentValue is still updated with the current value.
* This property helps writing concise code for the following incr: * This property helps writing concise code for the following incr:
* *
@ -241,7 +241,7 @@ bool core_util_atomic_cas_u32(uint32_t *ptr, uint32_t *expectedCurrentValue, uin
* @param[in,out] expectedCurrentValue A pointer to some location holding the * @param[in,out] expectedCurrentValue A pointer to some location holding the
* expected current value of the data being set atomically. * expected current value of the data being set atomically.
* The computed 'desiredValue' should be a function of this current value. * The computed 'desiredValue' should be a function of this current value.
* @Note: This is an in-out parameter. In the * @note: This is an in-out parameter. In the
* failure case of atomic_cas (where the * failure case of atomic_cas (where the
* destination isn't set), the pointee of expectedCurrentValue is * destination isn't set), the pointee of expectedCurrentValue is
* updated with the current value. * updated with the current value.
@ -264,7 +264,7 @@ bool core_util_atomic_cas_u32(uint32_t *ptr, uint32_t *expectedCurrentValue, uin
* return true * return true
* } * }
* *
* @Note: In the failure case (where the destination isn't set), the value * @note: In the failure case (where the destination isn't set), the value
* pointed to by expectedCurrentValue is still updated with the current value. * pointed to by expectedCurrentValue is still updated with the current value.
* This property helps writing concise code for the following incr: * This property helps writing concise code for the following incr:
* *

4
platform/mbed_interface.h
View File

@ -115,14 +115,14 @@ void mbed_die(void);
/** Print out an error message. This is typically called when /** Print out an error message. This is typically called when
* hanlding a crash. * hanlding a crash.
* *
* @Note Synchronization level: Interrupt safe * @note Synchronization level: Interrupt safe
*/ */
void mbed_error_printf(const char* format, ...); void mbed_error_printf(const char* format, ...);
/** Print out an error message. Similar to mbed_error_printf /** Print out an error message. Similar to mbed_error_printf
* but uses a va_list. * but uses a va_list.
* *
* @Note Synchronization level: Interrupt safe * @note Synchronization level: Interrupt safe
*/ */
void mbed_error_vfprintf(const char * format, va_list arg); void mbed_error_vfprintf(const char * format, va_list arg);

4
platform/mbed_rtc_time.h
View File

@ -61,7 +61,7 @@ extern "C" {
* *
* @param t Number of seconds since January 1, 1970 (the UNIX timestamp) * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)
* *
* @Note Synchronization level: Thread safe * @note Synchronization level: Thread safe
* *
* Example: * Example:
* @code * @code
@ -76,7 +76,7 @@ void set_time(time_t t);
/** Attach an external RTC to be used for the C time functions /** Attach an external RTC to be used for the C time functions
* *
* @Note Synchronization level: Thread safe * @note Synchronization level: Thread safe
* *
* @param read_rtc pointer to function which returns current UNIX timestamp * @param read_rtc pointer to function which returns current UNIX timestamp
* @param write_rtc pointer to function which sets current UNIX timestamp, can be NULL * @param write_rtc pointer to function which sets current UNIX timestamp, can be NULL