mirror of https://github.com/ARMmbed/mbed-os.git
Update class documentation tags
stop using scope for \addtogroup. It was placing class methods into the group documentation instead of the class documentation. The new style is to explicitly tag the class as @ingroup. This new method will allow the class to be linked in the group page, and the class page will contain the detailed documentation of the class methods.pull/4111/head
Jimmy Brisson
parent
b3ce99676b
commit
f945d71319
|
|
@ -26,7 +26,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** An analog input, used for reading the voltage on a pin
|
||||
*
|
||||
|
|
@ -48,6 +47,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class AnalogIn {
|
||||
|
||||
|
|
@ -128,4 +128,3 @@ protected:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** An analog output, used for setting the voltage on a pin
|
||||
*
|
||||
|
|
@ -48,6 +47,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class AnalogOut {
|
||||
|
||||
|
|
@ -146,5 +146,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,11 +22,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital input bus, used for reading the state of a collection of pins
|
||||
*
|
||||
* @note Synchronization level: Thread safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class BusIn {
|
||||
|
||||
|
|
@ -125,4 +125,3 @@ private:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital input output bus, used for setting the state of a collection of pins
|
||||
*
|
||||
* @note Synchronization level: Thread safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class BusInOut {
|
||||
|
||||
|
|
@ -142,5 +142,3 @@ private:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital output bus, used for setting the state of a collection of pins
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class BusOut {
|
||||
|
||||
|
|
@ -126,5 +126,3 @@ private:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** CANMessage class
|
||||
*
|
||||
* @note Synchronization level: Thread safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class CANMessage : public CAN_Message {
|
||||
|
||||
|
|
@ -67,6 +67,7 @@ public:
|
|||
};
|
||||
|
||||
/** A can bus client, used for communicating with can devices
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class CAN {
|
||||
|
||||
|
|
@ -259,4 +260,3 @@ protected:
|
|||
|
||||
#endif // MBED_CAN_H
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -23,7 +23,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital input, used for reading the state of a pin
|
||||
*
|
||||
|
|
@ -47,6 +46,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class DigitalIn {
|
||||
|
||||
|
|
@ -115,5 +115,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -23,11 +23,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital input/output, used for setting or reading a bi-directional pin
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class DigitalInOut {
|
||||
|
||||
|
|
@ -140,5 +140,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital output, used for setting the state of a pin
|
||||
*
|
||||
|
|
@ -42,6 +41,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class DigitalOut {
|
||||
|
||||
|
|
@ -126,5 +126,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** An ethernet interface, to use with the ethernet pins.
|
||||
*
|
||||
|
|
@ -53,6 +52,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class Ethernet {
|
||||
|
||||
|
|
@ -172,5 +172,3 @@ public:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -31,11 +31,11 @@
|
|||
namespace mbed {
|
||||
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Flash IAP driver. It invokes flash HAL functions.
|
||||
*
|
||||
* @note Synchronization level: Thread safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class FlashIAP {
|
||||
public:
|
||||
|
|
@ -134,5 +134,3 @@ private:
|
|||
#endif /* DEVICE_FLASH */
|
||||
|
||||
#endif /* MBED_FLASHIAP_H */
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -32,7 +32,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** An I2C Master, used for communicating with I2C slave devices
|
||||
*
|
||||
|
|
@ -52,6 +51,7 @@ namespace mbed {
|
|||
* i2c.read(address, data, 2);
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class I2C {
|
||||
|
||||
|
|
@ -194,5 +194,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** An I2C Slave, used for communicating with an I2C Master device
|
||||
*
|
||||
|
|
@ -61,6 +60,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class I2CSlave {
|
||||
|
||||
|
|
@ -156,5 +156,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -28,7 +28,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A digital interrupt input, used to call a function on a rising or falling edge
|
||||
*
|
||||
|
|
@ -55,6 +54,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class InterruptIn {
|
||||
|
||||
|
|
@ -159,5 +159,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -23,7 +23,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Use this singleton if you need to chain interrupt handlers.
|
||||
*
|
||||
|
|
@ -52,6 +51,7 @@ namespace mbed {
|
|||
* InterruptManager::get()->add_handler(handler, TIMER3_IRQn);
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class InterruptManager {
|
||||
public:
|
||||
|
|
@ -170,6 +170,3 @@ private:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Low Power Ticker
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class LowPowerTicker : public Ticker {
|
||||
|
||||
|
|
@ -46,5 +46,3 @@ public:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Low Power Timout
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class LowPowerTimeout : public LowPowerTicker {
|
||||
|
||||
|
|
@ -44,5 +44,3 @@ private:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Low power timer
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class LowPowerTimer : public Timer {
|
||||
|
||||
|
|
@ -44,5 +44,3 @@ public:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A multiple pin digital input
|
||||
*
|
||||
|
|
@ -51,6 +50,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class PortIn {
|
||||
public:
|
||||
|
|
@ -100,5 +100,3 @@ private:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A multiple pin digital in/out used to set/read multiple bi-directional pins
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class PortInOut {
|
||||
public:
|
||||
|
|
@ -115,5 +115,3 @@ private:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** A multiple pin digital out
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
|
|
@ -50,6 +49,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class PortOut {
|
||||
public:
|
||||
|
|
@ -109,5 +109,3 @@ private:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A pulse-width modulation digital output
|
||||
*
|
||||
|
|
@ -47,6 +46,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class PwmOut {
|
||||
|
||||
|
|
@ -182,5 +182,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A serial port (UART) for communication with other serial devices
|
||||
* This is a variation of the Serial class that doesn't use streams,
|
||||
|
|
@ -48,6 +47,7 @@ namespace mbed {
|
|||
* pc.putc('A');
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class RawSerial: public SerialBase {
|
||||
|
||||
|
|
@ -103,5 +103,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -34,7 +34,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A SPI Master, used for communicating with SPI slave devices
|
||||
*
|
||||
|
|
@ -71,6 +70,7 @@ namespace mbed {
|
|||
*
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup dirvers
|
||||
*/
|
||||
class SPI {
|
||||
|
||||
|
|
@ -261,5 +261,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A SPI slave, used for communicating with a SPI Master device
|
||||
*
|
||||
|
|
@ -51,6 +50,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class SPISlave {
|
||||
|
||||
|
|
@ -124,5 +124,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -27,7 +27,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A serial port (UART) for communication with other serial devices
|
||||
*
|
||||
|
|
@ -48,6 +47,7 @@ namespace mbed {
|
|||
* pc.printf("Hello World\n");
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class Serial : public SerialBase, public Stream {
|
||||
|
||||
|
|
@ -95,5 +95,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -32,12 +32,12 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A base class for serial port implementations
|
||||
* Can't be instantiated directly (use Serial or RawSerial)
|
||||
*
|
||||
* @note Synchronization level: Set by subclass
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class SerialBase {
|
||||
|
||||
|
|
@ -258,5 +258,3 @@ protected:
|
|||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A Ticker is used to call a function at a recurring interval
|
||||
*
|
||||
|
|
@ -58,6 +57,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class Ticker : public TimerEvent {
|
||||
|
||||
|
|
@ -142,5 +142,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -20,7 +20,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A Timeout is used to call a function at a point in the future
|
||||
*
|
||||
|
|
@ -51,6 +50,7 @@ namespace mbed {
|
|||
* }
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class Timeout : public Ticker {
|
||||
|
||||
|
|
@ -61,5 +61,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** A general purpose timer
|
||||
*
|
||||
|
|
@ -45,6 +44,7 @@ namespace mbed {
|
|||
* printf("Toggle the led takes %d us", end - begin);
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class Timer {
|
||||
|
||||
|
|
@ -93,5 +93,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
|
||||
/** Base abstraction for timer interrupts
|
||||
*
|
||||
* @note Synchronization level: Interrupt safe
|
||||
* @ingroup drivers
|
||||
*/
|
||||
class TimerEvent {
|
||||
public:
|
||||
|
|
@ -58,5 +58,3 @@ protected:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@
|
|||
|
||||
namespace events {
|
||||
/** \addtogroup events */
|
||||
/** @{*/
|
||||
|
||||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename F>
|
||||
class Event;
|
||||
|
|
@ -33,6 +33,7 @@ class Event;
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <>
|
||||
class Event<void()> {
|
||||
|
|
@ -429,6 +430,7 @@ public:
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename A0>
|
||||
class Event<void(A0)> {
|
||||
|
|
@ -825,6 +827,7 @@ public:
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename A0, typename A1>
|
||||
class Event<void(A0, A1)> {
|
||||
|
|
@ -1221,6 +1224,7 @@ public:
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename A0, typename A1, typename A2>
|
||||
class Event<void(A0, A1, A2)> {
|
||||
|
|
@ -1617,6 +1621,7 @@ public:
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename A0, typename A1, typename A2, typename A3>
|
||||
class Event<void(A0, A1, A2, A3)> {
|
||||
|
|
@ -2013,6 +2018,7 @@ public:
|
|||
/** Event
|
||||
*
|
||||
* Representation of an event for fine-grain dispatch control
|
||||
* @ingroup events
|
||||
*/
|
||||
template <typename A0, typename A1, typename A2, typename A3, typename A4>
|
||||
class Event<void(A0, A1, A2, A3, A4)> {
|
||||
|
|
@ -2407,6 +2413,8 @@ public:
|
|||
};
|
||||
|
||||
|
||||
/** \addtogroup events */
|
||||
/** @{ */
|
||||
|
||||
// Convenience functions declared here to avoid cyclic
|
||||
// dependency between Event and EventQueue
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@
|
|||
|
||||
namespace events {
|
||||
/** \addtogroup events */
|
||||
/** @{*/
|
||||
|
||||
/** EVENTS_EVENT_SIZE
|
||||
* Minimum size of an event
|
||||
|
|
@ -46,6 +45,7 @@ class Event;
|
|||
/** EventQueue
|
||||
*
|
||||
* Flexible event queue for dispatching events
|
||||
* @ingroup events
|
||||
*/
|
||||
class EventQueue {
|
||||
public:
|
||||
|
|
@ -2698,4 +2698,3 @@ protected:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -72,11 +72,13 @@
|
|||
|
||||
/* IRQ/Exception compatible thunk entry function */
|
||||
typedef void (*CThunkEntry)(void);
|
||||
/** @}*/
|
||||
|
||||
/**
|
||||
* Class for created a pointer with data bound to it
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template<class T>
|
||||
class CThunk
|
||||
|
|
@ -242,4 +244,3 @@ class CThunk
|
|||
|
||||
#endif/*__CTHUNK_H__*/
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,7 +22,6 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
/** Group one or more functions in an instance of a CallChain, then call them in
|
||||
* sequence using CallChain::call(). Used mostly by the interrupt chaining code,
|
||||
|
|
@ -60,6 +59,7 @@ namespace mbed {
|
|||
* chain.call();
|
||||
* }
|
||||
* @endcode
|
||||
* @ingroup platform
|
||||
*/
|
||||
|
||||
typedef Callback<void()> *pFunctionPointer_t;
|
||||
|
|
@ -189,4 +189,3 @@ private:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename F>
|
||||
class Callback;
|
||||
|
|
@ -60,7 +60,8 @@ namespace detail {
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R>
|
||||
class Callback<R()> {
|
||||
|
|
@ -655,7 +656,8 @@ private:
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A0>
|
||||
class Callback<R(A0)> {
|
||||
|
|
@ -1250,7 +1252,8 @@ private:
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A0, typename A1>
|
||||
class Callback<R(A0, A1)> {
|
||||
|
|
@ -1845,7 +1848,8 @@ private:
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A0, typename A1, typename A2>
|
||||
class Callback<R(A0, A1, A2)> {
|
||||
|
|
@ -2440,7 +2444,8 @@ private:
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A0, typename A1, typename A2, typename A3>
|
||||
class Callback<R(A0, A1, A2, A3)> {
|
||||
|
|
@ -3035,7 +3040,8 @@ private:
|
|||
|
||||
/** Callback class based on template specialization
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A0, typename A1, typename A2, typename A3, typename A4>
|
||||
class Callback<R(A0, A1, A2, A3, A4)> {
|
||||
|
|
@ -4649,6 +4655,3 @@ Callback<R(A0, A1, A2, A3, A4)> callback(const volatile U *obj, R (*func)(const
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
/** Templated Circular buffer class
|
||||
*
|
||||
* @Note Synchronization level: Interrupt safe
|
||||
* @ingroup plaftorm
|
||||
*/
|
||||
template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
|
||||
class CircularBuffer {
|
||||
|
|
@ -116,4 +116,3 @@ private:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,8 +21,7 @@
|
|||
#include "platform/FileHandle.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** \addtogroup platform */
|
||||
|
||||
|
||||
/** Represents a directory stream. Objects of this type are returned
|
||||
|
|
@ -40,6 +39,7 @@ namespace mbed {
|
|||
*
|
||||
* @note to create a directory, @see Dir
|
||||
* @Note Synchronization level: Set by subclass
|
||||
* @ingroup platform
|
||||
*/
|
||||
class DirHandle {
|
||||
public:
|
||||
|
|
@ -146,5 +146,3 @@ public:
|
|||
} // namespace mbed
|
||||
|
||||
#endif /* MBED_DIRHANDLE_H */
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -26,14 +26,19 @@ typedef int FILEHANDLE;
|
|||
#include "platform/PlatformMutex.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
typedef enum {
|
||||
FilePathType,
|
||||
FileSystemPathType
|
||||
} PathType;
|
||||
/** @}*/
|
||||
|
||||
/**
|
||||
* @class FileBase
|
||||
* @ingroup platform
|
||||
*/
|
||||
class FileBase {
|
||||
public:
|
||||
FileBase(const char *name, PathType t);
|
||||
|
|
@ -62,4 +67,3 @@ private:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,8 +22,7 @@ typedef int FILEHANDLE;
|
|||
#include "platform/platform.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** \addtogroup platform */
|
||||
|
||||
|
||||
/** Class FileHandle
|
||||
|
|
@ -34,6 +33,7 @@ namespace mbed {
|
|||
*
|
||||
* @note to create a file, @see File
|
||||
* @note Synchronization level: Set by subclass
|
||||
* @ingroup platform
|
||||
*/
|
||||
class FileHandle {
|
||||
public:
|
||||
|
|
@ -155,7 +155,6 @@ public:
|
|||
};
|
||||
|
||||
|
||||
/** @}*/
|
||||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -21,8 +21,7 @@
|
|||
#include "platform/FileHandle.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** \addtogroup platform */
|
||||
|
||||
|
||||
/* Class FileLike
|
||||
|
|
@ -30,6 +29,7 @@ namespace mbed {
|
|||
* fopen("/name", mode).
|
||||
*
|
||||
* @Note Synchronization level: Set by subclass
|
||||
* @ingroup platform
|
||||
*/
|
||||
class FileLike : public FileHandle, public FileBase {
|
||||
public:
|
||||
|
|
@ -42,7 +42,6 @@ public:
|
|||
};
|
||||
|
||||
|
||||
/** @}*/
|
||||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -22,9 +22,12 @@
|
|||
#include "platform/FileLike.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** \addtogroup platform */
|
||||
|
||||
/**
|
||||
* @class FileSystem
|
||||
* @ingroup platform
|
||||
*/
|
||||
class FileSystem;
|
||||
|
||||
class FilePath {
|
||||
|
|
@ -48,5 +51,3 @@ private:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -23,8 +23,7 @@
|
|||
#include "platform/DirHandle.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** @{*/
|
||||
/** \addtogroup platform */
|
||||
|
||||
/** A filesystem-like object is one that can be used to open files
|
||||
* though it by fopen("/name/filename", mode)
|
||||
|
|
@ -33,6 +32,7 @@ namespace mbed {
|
|||
* of the rest of the functions just return error values).
|
||||
*
|
||||
* @Note Synchronization level: Set by subclass
|
||||
* @ingroup platform
|
||||
*/
|
||||
class FileSystemLike : public FileBase {
|
||||
|
||||
|
|
@ -120,5 +120,3 @@ public:
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -23,11 +23,13 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
|
||||
// Declarations for backwards compatibility
|
||||
// To be foward compatible, code should adopt the Callback class
|
||||
/**
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R, typename A1>
|
||||
class FunctionPointerArg1 : public Callback<R(A1)> {
|
||||
public:
|
||||
|
|
@ -59,6 +61,9 @@ public:
|
|||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @ingroup platform
|
||||
*/
|
||||
template <typename R>
|
||||
class FunctionPointerArg1<R, void> : public Callback<R()> {
|
||||
public:
|
||||
|
|
@ -96,5 +101,3 @@ typedef FunctionPointerArg1<void, void> FunctionPointer;
|
|||
} // namespace mbed
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -24,11 +24,16 @@
|
|||
#include "platform/PlatformMutex.h"
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
FILEHANDLE local_file_open(const char* name, int flags);
|
||||
/** @}*/
|
||||
|
||||
/**
|
||||
* @class LocalFileHandle
|
||||
* @ingroup platform
|
||||
*/
|
||||
class LocalFileHandle : public FileHandle {
|
||||
|
||||
public:
|
||||
|
|
@ -91,6 +96,7 @@ protected:
|
|||
*
|
||||
* The drive will only re-appear when the microcontroller program exists. Note that if the program does
|
||||
* not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
|
||||
* @ingroup platform
|
||||
*/
|
||||
class LocalFileSystem : public FileSystemLike {
|
||||
// No modifiable state
|
||||
|
|
@ -111,4 +117,3 @@ public:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
/* mbed Microcontroller Library
|
||||
* Copyright (c) 2006-2013 ARM Limited
|
||||
*
|
||||
|
|
@ -24,6 +23,7 @@
|
|||
typedef rtos::Mutex PlatformMutex;
|
||||
#else
|
||||
/** A stub mutex for when an RTOS is not present
|
||||
* @ingroup platform
|
||||
*/
|
||||
class PlatformMutex {
|
||||
public:
|
||||
|
|
@ -48,4 +48,3 @@ public:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -55,6 +55,7 @@ inline static void singleton_unlock(void)
|
|||
osMutexRelease (singleton_mutex_id);
|
||||
#endif
|
||||
}
|
||||
/** @}*/
|
||||
|
||||
/** Utility class for creating an using a singleton
|
||||
*
|
||||
|
|
@ -67,6 +68,7 @@ inline static void singleton_unlock(void)
|
|||
* @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
|
||||
*/
|
||||
template <class T>
|
||||
struct SingletonPtr {
|
||||
|
|
@ -107,4 +109,3 @@ struct SingletonPtr {
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -22,16 +22,18 @@
|
|||
#include <cstdarg>
|
||||
|
||||
namespace mbed {
|
||||
/** \addtogroup drivers */
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
extern void mbed_set_unbuffered_stream(FILE *_file);
|
||||
extern int mbed_getc(FILE *_file);
|
||||
extern char* mbed_gets(char *s, int size, FILE *_file);
|
||||
/** @}*/
|
||||
|
||||
/** File stream
|
||||
*
|
||||
* @Note Synchronization level: Set by subclass
|
||||
* @ingroup platform
|
||||
*/
|
||||
class Stream : public FileLike {
|
||||
|
||||
|
|
@ -88,4 +90,3 @@ private:
|
|||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
|
|
@ -21,9 +21,9 @@
|
|||
|
||||
namespace mbed {
|
||||
/** \addtogroup platform */
|
||||
/** @{*/
|
||||
|
||||
/** Transaction structure
|
||||
* @ingroup platform
|
||||
*/
|
||||
typedef struct {
|
||||
void *tx_buffer; /**< Tx buffer */
|
||||
|
|
@ -38,6 +38,7 @@ typedef struct {
|
|||
/** Transaction class defines a transaction.
|
||||
*
|
||||
* @Note Synchronization level: Not protected
|
||||
* @ingroup platform
|
||||
*/
|
||||
template<typename Class>
|
||||
class Transaction {
|
||||
|
|
@ -75,5 +76,3 @@ private:
|
|||
}
|
||||
|
||||
#endif
|
||||
|
||||
/** @}*/
|
||||
|
|
|
|||
Loading…
Reference in New Issue