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

sg- · sg- · commit 5e7ce5fa2364 · 2017-04-25T14:37:08.000-05:00
diff --git 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<class T>
diff --git 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
@@ -23,7 +23,7 @@ namespace mbed {
 
 /** Templated Circular buffer class
  *
- *  @Note Synchronization level: Interrupt safe
+ *  @note Synchronization level: Interrupt safe
  *  @ingroup platform
  */
 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
diff --git 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
@@ -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
@@ -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
@@ -67,7 +67,7 @@ class LocalFileHandle : public FileHandle {
  *  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
@@ -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
@@ -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
@@ -37,7 +37,7 @@ typedef struct {
 
 /** Transaction class defines a transaction.
  *
- * @Note Synchronization level: Not protected
+ * @note Synchronization level: Not protected
  * @ingroup platform
  */
 template<typename Class>
diff --git 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
@@ -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
@@ -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

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ typedef void (*CThunkEntry)(void);`
`77`	`77`	`/**`
`78`	`78`	`* Class for created a pointer with data bound to it`
`79`	`79`	`*`
`80`		`- * @Note Synchronization level: Not protected`
	`80`	`+ * @note Synchronization level: Not protected`
`81`	`81`	`* @ingroup platform`
`82`	`82`	`*/`
`83`	`83`	`template<class T>`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ namespace mbed {`
`27`	`27`	`* sequence using CallChain::call(). Used mostly by the interrupt chaining code,`
`28`	`28`	`* but can be used for other purposes.`
`29`	`29`	`*`
`30`		`- * @Note Synchronization level: Not protected`
	`30`	`+ * @note Synchronization level: Not protected`
`31`	`31`	`*`
`32`	`32`	`* Example:`
`33`	`33`	`* @code`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ namespace mbed {`
`23`	`23`
`24`	`24`	`/** Templated Circular buffer class`
`25`	`25`	`*`
`26`		`- * @Note Synchronization level: Interrupt safe`
	`26`	`+ * @note Synchronization level: Interrupt safe`
`27`	`27`	`* @ingroup platform`
`28`	`28`	`*/`
`29`	`29`	`template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ namespace mbed {`
`38`	`38`	`* reflect this.`
`39`	`39`	`*`
`40`	`40`	`* @note to create a directory, @see Dir`
`41`		`- * @Note Synchronization level: Set by subclass`
	`41`	`+ * @note Synchronization level: Set by subclass`
`42`	`42`	`* @ingroup platform`
`43`	`43`	`*/`
`44`	`44`	`class DirHandle {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ namespace mbed {`
`28`	`28`	`* A file-like object is one that can be opened with fopen by`
`29`	`29`	`* fopen("/name", mode).`
`30`	`30`	`*`
`31`		`- * @Note Synchronization level: Set by subclass`
	`31`	`+ * @note Synchronization level: Set by subclass`
`32`	`32`	`* @ingroup platform`
`33`	`33`	`*/`
`34`	`34`	`class FileLike : public FileHandle, public FileBase {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ namespace mbed {`
`31`	`31`	`* Implementations must define at least open (the default definitions`
`32`	`32`	`* of the rest of the functions just return error values).`
`33`	`33`	`*`
`34`		`- * @Note Synchronization level: Set by subclass`
	`34`	`+ * @note Synchronization level: Set by subclass`
`35`	`35`	`* @ingroup platform`
`36`	`36`	`*/`
`37`	`37`	`class FileSystemLike : public FileBase {`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ class LocalFileHandle : public FileHandle {`
`67`	`67`	`* mbed Microcontroller. Once created, the standard C file access functions are used to open,`
`68`	`68`	`* read and write files.`
`69`	`69`	`*`
`70`		`- * @Note Synchronization level: Thread safe`
	`70`	`+ * @note Synchronization level: Thread safe`
`71`	`71`	`*`
`72`	`72`	`* Example:`
`73`	`73`	`* @code`
Original file line number	Diff line number	Diff line change
`@@ -59,13 +59,13 @@ inline static void singleton_unlock(void)`
`59`	`59`
`60`	`60`	`/** Utility class for creating an using a singleton`
`61`	`61`	`*`
`62`		`- * @Note Synchronization level: Thread safe`
	`62`	`+ * @note Synchronization level: Thread safe`
`63`	`63`	`*`
`64`		`- * @Note: This class must only be used in a static context -`
	`64`	`+ * @note: This class must only be used in a static context -`
`65`	`65`	`* this class must never be allocated or created on the`
`66`	`66`	`* stack.`
`67`	`67`	`*`
`68`		`- * @Note: This class is lazily initialized on first use.`
	`68`	`+ * @note: This class is lazily initialized on first use.`
`69`	`69`	`* This class is a POD type so if it is not used it will`
`70`	`70`	`* be garbage collected.`
`71`	`71`	`* @ingroup platform`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ extern char* mbed_gets(char s, int size, FILE _file);`
`32`	`32`
`33`	`33`	`/** File stream`
`34`	`34`	`*`
`35`		`- * @Note Synchronization level: Set by subclass`
	`35`	`+ * @note Synchronization level: Set by subclass`
`36`	`36`	`* @ingroup platform`
`37`	`37`	`*/`
`38`	`38`	`class Stream : public FileLike {`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ typedef struct {`
`37`	`37`
`38`	`38`	`/** Transaction class defines a transaction.`
`39`	`39`	`*`
`40`		`- * @Note Synchronization level: Not protected`
	`40`	`+ * @note Synchronization level: Not protected`
`41`	`41`	`* @ingroup platform`
`42`	`42`	`*/`
`43`	`43`	`template<typename Class>`