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

Fix doxygen comments to reflect the deprecated functions

pull/6531/head
Senthil Ramakrishnan 2018-04-03 14:07:03 -05:00
parent 4a5ac149ec
commit 194b89cce6
5 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
drivers/InterruptManager.h
View File

@ -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 @@ public:
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 @@ public:
}
/** 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 @@ public:
}
/** 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 @@ public:
}
/** 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 @@ public:
}
/** 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

3
platform/ATCmdParser.h
View File

@ -124,6 +124,7 @@ public:
/**
* 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 @@ public:
/**
* 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 @@ public:
/**
* 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
*

36
platform/CallChain.h
View File

@ -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,6 +75,8 @@ 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
*/
@ -81,11 +84,18 @@ public:
"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 @@ public:
}
/** 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 @@ public:
}
/** 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 @@ public:
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 @@ public:
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 @@ public:
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 {

2
platform/CriticalSectionLock.h
View File

@ -68,6 +68,7 @@ public:
}
/** 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 @@ public:
}
/** 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",

3
platform/mbed_power_mgmt.h
View File

@ -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)