mirror of https://github.com/ARMmbed/mbed-os.git
Merge branch 'rtos-doxy-typo-fix' of https://github.com/kegilbert/mbed-os into dev_rollup
commit
9d1aa738eb
|
|
@ -37,7 +37,7 @@ namespace rtos {
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** The Queue class represents a collection of objects that are stored first by
|
/** The Queue class represents a collection of objects that are stored first by
|
||||||
* order of priorty, and then in first-in, first-out (FIFO) order.
|
* order of priority, and then in first-in, first-out (FIFO) order.
|
||||||
*
|
*
|
||||||
* You can use a queue when you need to store data and then access it in the same
|
* You can use a queue when you need to store data and then access it in the same
|
||||||
* order that it has been stored. The order in which you retrieve the data is in
|
* order that it has been stored. The order in which you retrieve the data is in
|
||||||
|
|
|
||||||
|
|
@ -88,7 +88,7 @@ class RtosTimer : private mbed::NonCopyable<RtosTimer> {
|
||||||
public:
|
public:
|
||||||
/** Create timer.
|
/** Create timer.
|
||||||
@param func function to be executed by this timer.
|
@param func function to be executed by this timer.
|
||||||
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
|
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
|
||||||
@param argument argument to the timer call back function. (default: NULL)
|
@param argument argument to the timer call back function. (default: NULL)
|
||||||
@deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
|
@deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
|
||||||
@deprecated
|
@deprecated
|
||||||
|
|
@ -107,7 +107,7 @@ public:
|
||||||
|
|
||||||
/** Create timer.
|
/** Create timer.
|
||||||
@param func function to be executed by this timer.
|
@param func function to be executed by this timer.
|
||||||
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
|
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
|
||||||
@deprecated
|
@deprecated
|
||||||
The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
|
The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
|
||||||
|
|
||||||
|
|
@ -123,7 +123,7 @@ public:
|
||||||
/** Create timer.
|
/** Create timer.
|
||||||
@param obj pointer to the object to call the member function on.
|
@param obj pointer to the object to call the member function on.
|
||||||
@param method member function to be executed by this timer.
|
@param method member function to be executed by this timer.
|
||||||
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
|
@param type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior. (default: osTimerPeriodic)
|
||||||
@deprecated
|
@deprecated
|
||||||
The RtosTimer constructor does not support cv-qualifiers. Replaced by
|
The RtosTimer constructor does not support cv-qualifiers. Replaced by
|
||||||
RtosTimer(callback(obj, method), os_timer_type).
|
RtosTimer(callback(obj, method), os_timer_type).
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue