Fix doxygen comments to reflect the deprecated functions

SenRamakri · adbridge · commit 07ea79cc5942 · 2018-04-09T15:00:48.000+01:00
diff --git a/drivers/InterruptManager.h b/drivers/InterruptManager.h
@@ -26,6 +26,7 @@ namespace mbed {
 /** \addtogroup drivers */
 
 /** Use this singleton if you need to chain interrupt handlers.
+ *  @deprecated Do not use this class. This class is not part of the public API of mbed-os and is being removed in the future.
  *
  * @note Synchronization level: Thread safe
  *
@@ -57,6 +58,8 @@ namespace mbed {
 class InterruptManager : private NonCopyable<InterruptManager> {
 public:
     /** Get the instance of InterruptManager Class
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @return the only instance of this class
      */
@@ -65,12 +68,17 @@ class InterruptManager : private NonCopyable<InterruptManager> {
     static InterruptManager* get();
 
     /** Destroy the current instance of the interrupt manager
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     static void destroy();
 
     /** Add a handler for an interrupt at the end of the handler list
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param function the handler to add
      *  @param irq interrupt number
@@ -86,6 +94,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {
     }
 
     /** Add a handler for an interrupt at the beginning of the handler list
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param function the handler to add
      *  @param irq interrupt number
@@ -101,6 +111,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {
     }
 
     /** Add a handler for an interrupt at the end of the handler list
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param tptr pointer to the object that has the handler function
      *  @param mptr pointer to the actual handler function
@@ -118,6 +130,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {
     }
 
     /** Add a handler for an interrupt at the beginning of the handler list
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param tptr pointer to the object that has the handler function
      *  @param mptr pointer to the actual handler function
@@ -135,6 +149,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {
     }
 
     /** Remove a handler from an interrupt
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param handler the function object for the handler to remove
      *  @param irq the interrupt number
diff --git a/platform/ATCmdParser.h b/platform/ATCmdParser.h
@@ -124,6 +124,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>
 
     /**
      * For backwards compatibility.
+     * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.
      *
      * Please use set_timeout(int) API only from now on.
      * Allows timeout to be changed between commands
@@ -149,6 +150,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>
 
     /**
      * For backwards compatibility.
+     * @deprecated Do not use this function. This function has been replaced with set_delimiter for consistency.
      *
      * Please use set_delimiter(const char *) API only from now on.
      * Sets string of characters to use as line delimiters
@@ -173,6 +175,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>
 
     /**
      * For backwards compatibility.
+     * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.
      *
      * Allows traces from modem to be turned on or off
      *
diff --git a/platform/CallChain.h b/platform/CallChain.h
@@ -38,6 +38,7 @@ class CallChainLink;
  * sequence using CallChain::call(). Used mostly by the interrupt chaining code,
  * but can be used for other purposes.
  *
+ * @deprecated Do not use this class. This class is not part of the public API of mbed-os and is being removed in the future.
  * @note Synchronization level: Not protected
  *
  * Example:
@@ -74,18 +75,27 @@ class CallChainLink;
 class CallChain : private NonCopyable<CallChain> {
 public:
     /** Create an empty chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param size (optional) Initial size of the chain
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     CallChain(int size = 4);
 
+    /** Create an empty chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     virtual ~CallChain();
 
     /** Add a function at the end of the chain
+     *
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param func A pointer to a void function
      *
@@ -117,6 +127,9 @@ class CallChain : private NonCopyable<CallChain> {
     }
 
     /** Add a function at the beginning of the chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
      *
      *  @param func A pointer to a void function
      *
@@ -148,12 +161,17 @@ class CallChain : private NonCopyable<CallChain> {
     }
 
     /** Get the number of functions in the chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     int size() const;
 
     /** Get a function object from the chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param i function object index
      *
@@ -165,6 +183,8 @@ class CallChain : private NonCopyable<CallChain> {
     pFunctionPointer_t get(int i) const;
 
     /** Look for a function object in the call chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @param f the function object to search
      *
@@ -176,12 +196,15 @@ class CallChain : private NonCopyable<CallChain> {
     int find(pFunctionPointer_t f) const;
 
     /** Clear the call chain (remove all functions in the chain).
+     *  @deprecated Do not use this function. This class is not part of the public API of mbed-os and is being removed in the future.
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     void clear();
 
     /** Remove a function object from the chain
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
      *
      *  @arg f the function object to remove
      *
@@ -193,17 +216,30 @@ class CallChain : private NonCopyable<CallChain> {
     bool remove(pFunctionPointer_t f);
 
     /** Call all the functions in the chain in sequence
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     void call();
 
+    /** 
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     void operator ()(void) {
         call();
     }
 
+    /** 
+     *  @deprecated 
+     *  Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.
+     *
+     */
     MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "
         "public API of mbed-os and is being removed in the future.")
     pFunctionPointer_t operator [](int i) const {
diff --git a/platform/CriticalSectionLock.h b/platform/CriticalSectionLock.h
@@ -68,6 +68,7 @@ class CriticalSectionLock {
     }
 
     /** Mark the start of a critical section
+     *  @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
      *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.8",
@@ -79,6 +80,7 @@ class CriticalSectionLock {
     }
 
     /** Mark the end of a critical section
+     *  @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
      *
      */
     MBED_DEPRECATED_SINCE("mbed-os-5.8",
diff --git a/platform/mbed_power_mgmt.h b/platform/mbed_power_mgmt.h
@@ -167,6 +167,9 @@ static inline void sleep(void)
 }
 
 /** Send the microcontroller to deep sleep
+ *
+ * @deprecated
+ * Do not use this function. Applications should use sleep() API which puts the system in deepsleep mode if supported. 
  *
  * @note This function can be a noop if not implemented by the platform.
  * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined)

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ namespace mbed {`
`26`	`26`	`/** \addtogroup drivers */`
`27`	`27`
`28`	`28`	`/** Use this singleton if you need to chain interrupt handlers.`
	`29`	`+ * @deprecated Do not use this class. This class is not part of the public API of mbed-os and is being removed in the future.`
`29`	`30`	`*`
`30`	`31`	`* @note Synchronization level: Thread safe`
`31`	`32`	`*`
`@@ -57,6 +58,8 @@ namespace mbed {`
`57`	`58`	`class InterruptManager : private NonCopyable<InterruptManager> {`
`58`	`59`	`public:`
`59`	`60`	`/** Get the instance of InterruptManager Class`
	`61`	`+ * @deprecated`
	`62`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`60`	`63`	`*`
`61`	`64`	`* @return the only instance of this class`
`62`	`65`	`*/`
`@@ -65,12 +68,17 @@ class InterruptManager : private NonCopyable<InterruptManager> {`
`65`	`68`	`static InterruptManager* get();`
`66`	`69`
`67`	`70`	`/** Destroy the current instance of the interrupt manager`
	`71`	`+ * @deprecated`
	`72`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
	`73`	`+ *`
`68`	`74`	`*/`
`69`	`75`	`MBED_DEPRECATED_SINCE("mbed-os-5.6", "This class is not part of the "`
`70`	`76`	`"public API of mbed-os and is being removed in the future.")`
`71`	`77`	`static void destroy();`
`72`	`78`
`73`	`79`	`/** Add a handler for an interrupt at the end of the handler list`
	`80`	`+ * @deprecated`
	`81`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`74`	`82`	`*`
`75`	`83`	`* @param function the handler to add`
`76`	`84`	`* @param irq interrupt number`
`@@ -86,6 +94,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {`
`86`	`94`	`}`
`87`	`95`
`88`	`96`	`/** Add a handler for an interrupt at the beginning of the handler list`
	`97`	`+ * @deprecated`
	`98`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`89`	`99`	`*`
`90`	`100`	`* @param function the handler to add`
`91`	`101`	`* @param irq interrupt number`
`@@ -101,6 +111,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {`
`101`	`111`	`}`
`102`	`112`
`103`	`113`	`/** Add a handler for an interrupt at the end of the handler list`
	`114`	`+ * @deprecated`
	`115`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`104`	`116`	`*`
`105`	`117`	`* @param tptr pointer to the object that has the handler function`
`106`	`118`	`* @param mptr pointer to the actual handler function`
`@@ -118,6 +130,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {`
`118`	`130`	`}`
`119`	`131`
`120`	`132`	`/** Add a handler for an interrupt at the beginning of the handler list`
	`133`	`+ * @deprecated`
	`134`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`121`	`135`	`*`
`122`	`136`	`* @param tptr pointer to the object that has the handler function`
`123`	`137`	`* @param mptr pointer to the actual handler function`
`@@ -135,6 +149,8 @@ class InterruptManager : private NonCopyable<InterruptManager> {`
`135`	`149`	`}`
`136`	`150`
`137`	`151`	`/** Remove a handler from an interrupt`
	`152`	`+ * @deprecated`
	`153`	`+ * Do not use this function, this class is not part of the public API of mbed-os and is being removed in the future.`
`138`	`154`	`*`
`139`	`155`	`* @param handler the function object for the handler to remove`
`140`	`156`	`* @param irq the interrupt number`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>`
`124`	`124`
`125`	`125`	`/**`
`126`	`126`	`* For backwards compatibility.`
	`127`	`+ * @deprecated Do not use this function. This function has been replaced with set_timeout for consistency.`
`127`	`128`	`*`
`128`	`129`	`* Please use set_timeout(int) API only from now on.`
`129`	`130`	`* Allows timeout to be changed between commands`
`@@ -149,6 +150,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>`
`149`	`150`
`150`	`151`	`/**`
`151`	`152`	`* For backwards compatibility.`
	`153`	`+ * @deprecated Do not use this function. This function has been replaced with set_delimiter for consistency.`
`152`	`154`	`*`
`153`	`155`	`* Please use set_delimiter(const char *) API only from now on.`
`154`	`156`	`* Sets string of characters to use as line delimiters`
`@@ -173,6 +175,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser>`
`173`	`175`
`174`	`176`	`/**`
`175`	`177`	`* For backwards compatibility.`
	`178`	`+ * @deprecated Do not use this function. This function has been replaced with debug_on for consistency.`
`176`	`179`	`*`
`177`	`180`	`* Allows traces from modem to be turned on or off`
`178`	`181`	`*`
Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,7 @@ class CriticalSectionLock {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/** Mark the start of a critical section`
	`71`	`+ * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.`
`71`	`72`	`*`
`72`	`73`	`*/`
`73`	`74`	`MBED_DEPRECATED_SINCE("mbed-os-5.8",`
`@@ -79,6 +80,7 @@ class CriticalSectionLock {`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`/** Mark the end of a critical section`
	`83`	`+ * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.`
`82`	`84`	`*`
`83`	`85`	`*/`
`84`	`86`	`MBED_DEPRECATED_SINCE("mbed-os-5.8",`
Original file line number	Diff line number	Diff line change
`@@ -167,6 +167,9 @@ static inline void sleep(void)`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`/** Send the microcontroller to deep sleep`
	`170`	`+ *`
	`171`	`+ * @deprecated`
	`172`	`+ * Do not use this function. Applications should use sleep() API which puts the system in deepsleep mode if supported.`
`170`	`173`	`*`
`171`	`174`	`* @note This function can be a noop if not implemented by the platform.`
`172`	`175`	`* @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined)`