diff --git a/platform/CThunk.h b/platform/CThunk.h index d41bd76f02..a1db2cf205 100644 --- a/platform/CThunk.h +++ b/platform/CThunk.h @@ -77,7 +77,7 @@ typedef void (*CThunkEntry)(void); /** * Class for created a pointer with data bound to it * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected * @ingroup platform */ template diff --git a/platform/CallChain.h b/platform/CallChain.h index 58ca6f8d5d..421ffb4fc5 100644 --- a/platform/CallChain.h +++ b/platform/CallChain.h @@ -27,7 +27,7 @@ namespace mbed { * sequence using CallChain::call(). Used mostly by the interrupt chaining code, * but can be used for other purposes. * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected * * Example: * @code diff --git a/platform/CircularBuffer.h b/platform/CircularBuffer.h index b4278d4fba..ef3fea7f65 100644 --- a/platform/CircularBuffer.h +++ b/platform/CircularBuffer.h @@ -23,7 +23,7 @@ namespace mbed { /** Templated Circular buffer class * - * @Note Synchronization level: Interrupt safe + * @note Synchronization level: Interrupt safe * @ingroup platform */ template diff --git a/platform/DirHandle.h b/platform/DirHandle.h index 8bdbd1dd61..431d895fc9 100644 --- a/platform/DirHandle.h +++ b/platform/DirHandle.h @@ -38,7 +38,7 @@ namespace mbed { * reflect this. * * @note to create a directory, @see Dir - * @Note Synchronization level: Set by subclass + * @note Synchronization level: Set by subclass * @ingroup platform */ class DirHandle { diff --git a/platform/FileLike.h b/platform/FileLike.h index 9c07c66ce9..e65e611aa9 100644 --- a/platform/FileLike.h +++ b/platform/FileLike.h @@ -28,7 +28,7 @@ namespace mbed { * A file-like object is one that can be opened with fopen by * fopen("/name", mode). * - * @Note Synchronization level: Set by subclass + * @note Synchronization level: Set by subclass * @ingroup platform */ class FileLike : public FileHandle, public FileBase { diff --git a/platform/FileSystemLike.h b/platform/FileSystemLike.h index 0d242a4fa7..269918bccf 100644 --- a/platform/FileSystemLike.h +++ b/platform/FileSystemLike.h @@ -31,7 +31,7 @@ namespace mbed { * Implementations must define at least open (the default definitions * of the rest of the functions just return error values). * - * @Note Synchronization level: Set by subclass + * @note Synchronization level: Set by subclass * @ingroup platform */ class FileSystemLike : public FileBase { diff --git a/platform/LocalFileSystem.h b/platform/LocalFileSystem.h index 1b23024b27..2aeb4f03c5 100644 --- a/platform/LocalFileSystem.h +++ b/platform/LocalFileSystem.h @@ -67,7 +67,7 @@ protected: * mbed Microcontroller. Once created, the standard C file access functions are used to open, * read and write files. * - * @Note Synchronization level: Thread safe + * @note Synchronization level: Thread safe * * Example: * @code diff --git a/platform/SingletonPtr.h b/platform/SingletonPtr.h index b192e1056d..e576b2632d 100644 --- a/platform/SingletonPtr.h +++ b/platform/SingletonPtr.h @@ -59,13 +59,13 @@ inline static void singleton_unlock(void) /** 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 * 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 * be garbage collected. * @ingroup platform diff --git a/platform/Stream.h b/platform/Stream.h index 865ad25d12..9fe100a418 100644 --- a/platform/Stream.h +++ b/platform/Stream.h @@ -32,7 +32,7 @@ extern char* mbed_gets(char *s, int size, FILE *_file); /** File stream * - * @Note Synchronization level: Set by subclass + * @note Synchronization level: Set by subclass * @ingroup platform */ class Stream : public FileLike { diff --git a/platform/Transaction.h b/platform/Transaction.h index 1967246d32..8e26236880 100644 --- a/platform/Transaction.h +++ b/platform/Transaction.h @@ -37,7 +37,7 @@ typedef struct { /** Transaction class defines a transaction. * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected * @ingroup platform */ template diff --git a/platform/mbed_critical.h b/platform/mbed_critical.h index 57816d1cac..dd4cbe6fb3 100644 --- a/platform/mbed_critical.h +++ b/platform/mbed_critical.h @@ -33,7 +33,7 @@ extern "C" { /** Determine the current interrupts enabled state * * This function can be called to determine whether or not interrupts are currently enabled. - * \note + * @note * NOTE: * This function works for both cortex-A and cortex-M, although the underlyng implementation * differs. @@ -44,7 +44,7 @@ bool core_util_are_interrupts_enabled(void); /** Mark the start of a critical section * * This function should be called to mark the start of a critical section of code. - * \note + * @note * NOTES: * 1) The use of this style of critical section is targetted at C based implementations. * 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 * * This function should be called to mark the end of a critical section of code. - * \note + * @note * NOTES: * 1) The use of this style of critical section is targetted at C based implementations. * 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 * expected current value of the data being set atomically. * 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 * destination isn't set), the pointee of expectedCurrentValue is * updated with the current value. @@ -105,7 +105,7 @@ void core_util_critical_section_exit(void); * 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. * 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 * expected current value of the data being set atomically. * 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 * destination isn't set), the pointee of expectedCurrentValue is * updated with the current value. @@ -158,7 +158,7 @@ bool core_util_atomic_cas_u8(uint8_t *ptr, uint8_t *expectedCurrentValue, uint8_ * 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. * 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 * expected current value of the data being set atomically. * 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 * destination isn't set), the pointee of expectedCurrentValue is * updated with the current value. @@ -211,7 +211,7 @@ bool core_util_atomic_cas_u16(uint16_t *ptr, uint16_t *expectedCurrentValue, uin * 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. * 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 * expected current value of the data being set atomically. * 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 * destination isn't set), the pointee of expectedCurrentValue is * updated with the current value. @@ -264,7 +264,7 @@ bool core_util_atomic_cas_u32(uint32_t *ptr, uint32_t *expectedCurrentValue, uin * 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. * This property helps writing concise code for the following incr: * diff --git a/platform/mbed_interface.h b/platform/mbed_interface.h index f39eb4724c..bb3e2a3489 100644 --- a/platform/mbed_interface.h +++ b/platform/mbed_interface.h @@ -115,14 +115,14 @@ void mbed_die(void); /** Print out an error message. This is typically called when * hanlding a crash. * - * @Note Synchronization level: Interrupt safe + * @note Synchronization level: Interrupt safe */ void mbed_error_printf(const char* format, ...); /** Print out an error message. Similar to mbed_error_printf * 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); diff --git a/platform/mbed_rtc_time.h b/platform/mbed_rtc_time.h index fef0292f1c..84a3739ec3 100644 --- a/platform/mbed_rtc_time.h +++ b/platform/mbed_rtc_time.h @@ -61,7 +61,7 @@ extern "C" { * * @param t Number of seconds since January 1, 1970 (the UNIX timestamp) * - * @Note Synchronization level: Thread safe + * @note Synchronization level: Thread safe * * Example: * @code @@ -76,7 +76,7 @@ void set_time(time_t t); /** 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 write_rtc pointer to function which sets current UNIX timestamp, can be NULL