From f945d7131951074350db417f28c8510694e86c6d Mon Sep 17 00:00:00 2001 From: Jimmy Brisson Date: Tue, 4 Apr 2017 14:21:53 -0500 Subject: [PATCH] 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. --- drivers/AnalogIn.h | 3 +-- drivers/AnalogOut.h | 4 +--- drivers/BusIn.h | 3 +-- drivers/BusInOut.h | 4 +--- drivers/BusOut.h | 4 +--- drivers/CAN.h | 4 ++-- drivers/DigitalIn.h | 4 +--- drivers/DigitalInOut.h | 4 +--- drivers/DigitalOut.h | 4 +--- drivers/Ethernet.h | 4 +--- drivers/FlashIAP.h | 4 +--- drivers/I2C.h | 4 +--- drivers/I2CSlave.h | 4 +--- drivers/InterruptIn.h | 4 +--- drivers/InterruptManager.h | 5 +---- drivers/LowPowerTicker.h | 4 +--- drivers/LowPowerTimeout.h | 4 +--- drivers/LowPowerTimer.h | 4 +--- drivers/PortIn.h | 4 +--- drivers/PortInOut.h | 4 +--- drivers/PortOut.h | 4 +--- drivers/PwmOut.h | 4 +--- drivers/RawSerial.h | 4 +--- drivers/SPI.h | 4 +--- drivers/SPISlave.h | 4 +--- drivers/Serial.h | 4 +--- drivers/SerialBase.h | 4 +--- drivers/Ticker.h | 4 +--- drivers/Timeout.h | 4 +--- drivers/Timer.h | 4 +--- drivers/TimerEvent.h | 4 +--- events/Event.h | 10 +++++++++- events/EventQueue.h | 3 +-- platform/CThunk.h | 3 ++- platform/CallChain.h | 3 +-- platform/Callback.h | 25 ++++++++++++++----------- platform/CircularBuffer.h | 3 +-- platform/DirHandle.h | 6 ++---- platform/FileBase.h | 8 ++++++-- platform/FileHandle.h | 5 ++--- platform/FileLike.h | 5 ++--- platform/FilePath.h | 9 +++++---- platform/FileSystemLike.h | 6 ++---- platform/FunctionPointer.h | 9 ++++++--- platform/LocalFileSystem.h | 9 +++++++-- platform/PlatformMutex.h | 3 +-- platform/SingletonPtr.h | 3 ++- platform/Stream.h | 5 +++-- platform/Transaction.h | 5 ++--- 49 files changed, 100 insertions(+), 143 deletions(-) diff --git a/drivers/AnalogIn.h b/drivers/AnalogIn.h index 72787d626a..dff8a30af3 100644 --- a/drivers/AnalogIn.h +++ b/drivers/AnalogIn.h @@ -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 -/** @}*/ diff --git a/drivers/AnalogOut.h b/drivers/AnalogOut.h index 2719f61ed0..8fd00c0b39 100644 --- a/drivers/AnalogOut.h +++ b/drivers/AnalogOut.h @@ -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 - -/** @}*/ diff --git a/drivers/BusIn.h b/drivers/BusIn.h index bd518ab682..0422b9350a 100644 --- a/drivers/BusIn.h +++ b/drivers/BusIn.h @@ -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 -/** @}*/ diff --git a/drivers/BusInOut.h b/drivers/BusInOut.h index 0bcc4f2394..e0c353b779 100644 --- a/drivers/BusInOut.h +++ b/drivers/BusInOut.h @@ -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 - -/** @}*/ diff --git a/drivers/BusOut.h b/drivers/BusOut.h index bceeb9ded7..1fcba6c100 100644 --- a/drivers/BusOut.h +++ b/drivers/BusOut.h @@ -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 - -/** @}*/ diff --git a/drivers/CAN.h b/drivers/CAN.h index 43f68b1b59..edf3f71f73 100644 --- a/drivers/CAN.h +++ b/drivers/CAN.h @@ -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 -/** @}*/ diff --git a/drivers/DigitalIn.h b/drivers/DigitalIn.h index f4c42332e7..ee3890e8ce 100644 --- a/drivers/DigitalIn.h +++ b/drivers/DigitalIn.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 - -/** @}*/ diff --git a/drivers/DigitalInOut.h b/drivers/DigitalInOut.h index 599c2db686..656d334a5e 100644 --- a/drivers/DigitalInOut.h +++ b/drivers/DigitalInOut.h @@ -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 - -/** @}*/ diff --git a/drivers/DigitalOut.h b/drivers/DigitalOut.h index d434d5e8e6..75a2311d0d 100644 --- a/drivers/DigitalOut.h +++ b/drivers/DigitalOut.h @@ -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 - -/** @}*/ diff --git a/drivers/Ethernet.h b/drivers/Ethernet.h index f2b028da8a..7e09498c58 100644 --- a/drivers/Ethernet.h +++ b/drivers/Ethernet.h @@ -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 - -/** @}*/ diff --git a/drivers/FlashIAP.h b/drivers/FlashIAP.h index ea28301558..5708d01e93 100644 --- a/drivers/FlashIAP.h +++ b/drivers/FlashIAP.h @@ -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 */ - -/** @}*/ diff --git a/drivers/I2C.h b/drivers/I2C.h index 7bd7645302..6d1acbfaef 100644 --- a/drivers/I2C.h +++ b/drivers/I2C.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 - -/** @}*/ diff --git a/drivers/I2CSlave.h b/drivers/I2CSlave.h index 2ecdf23144..3d4b843e43 100644 --- a/drivers/I2CSlave.h +++ b/drivers/I2CSlave.h @@ -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 - -/** @}*/ diff --git a/drivers/InterruptIn.h b/drivers/InterruptIn.h index eca5feb323..9559f82823 100644 --- a/drivers/InterruptIn.h +++ b/drivers/InterruptIn.h @@ -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 - -/** @}*/ diff --git a/drivers/InterruptManager.h b/drivers/InterruptManager.h index db4cf9c810..bab71a893c 100644 --- a/drivers/InterruptManager.h +++ b/drivers/InterruptManager.h @@ -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 - - -/** @}*/ diff --git a/drivers/LowPowerTicker.h b/drivers/LowPowerTicker.h index 2ce2120232..0c1793f937 100644 --- a/drivers/LowPowerTicker.h +++ b/drivers/LowPowerTicker.h @@ -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 - -/** @}*/ diff --git a/drivers/LowPowerTimeout.h b/drivers/LowPowerTimeout.h index 3adf6a47f3..fc4b30ae2d 100644 --- a/drivers/LowPowerTimeout.h +++ b/drivers/LowPowerTimeout.h @@ -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 - -/** @}*/ diff --git a/drivers/LowPowerTimer.h b/drivers/LowPowerTimer.h index b7fe45edc6..a882959a5a 100644 --- a/drivers/LowPowerTimer.h +++ b/drivers/LowPowerTimer.h @@ -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 - -/** @}*/ diff --git a/drivers/PortIn.h b/drivers/PortIn.h index 560d7a8f38..01ee37d862 100644 --- a/drivers/PortIn.h +++ b/drivers/PortIn.h @@ -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 - -/** @}*/ diff --git a/drivers/PortInOut.h b/drivers/PortInOut.h index e57644b434..50c662f790 100644 --- a/drivers/PortInOut.h +++ b/drivers/PortInOut.h @@ -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 - -/** @}*/ diff --git a/drivers/PortOut.h b/drivers/PortOut.h index 94e18d68e0..69572429a5 100644 --- a/drivers/PortOut.h +++ b/drivers/PortOut.h @@ -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 - -/** @}*/ diff --git a/drivers/PwmOut.h b/drivers/PwmOut.h index 8ec0a21935..ef5a26a66a 100644 --- a/drivers/PwmOut.h +++ b/drivers/PwmOut.h @@ -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 - -/** @}*/ diff --git a/drivers/RawSerial.h b/drivers/RawSerial.h index 2bec6b698e..95bec350bf 100644 --- a/drivers/RawSerial.h +++ b/drivers/RawSerial.h @@ -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 - -/** @}*/ diff --git a/drivers/SPI.h b/drivers/SPI.h index f39cbd555e..e6cd93aba1 100644 --- a/drivers/SPI.h +++ b/drivers/SPI.h @@ -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 - -/** @}*/ diff --git a/drivers/SPISlave.h b/drivers/SPISlave.h index a19ffbab19..e16bf46c13 100644 --- a/drivers/SPISlave.h +++ b/drivers/SPISlave.h @@ -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 - -/** @}*/ diff --git a/drivers/Serial.h b/drivers/Serial.h index 1fb52085b5..0739f1b6d0 100644 --- a/drivers/Serial.h +++ b/drivers/Serial.h @@ -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 - -/** @}*/ diff --git a/drivers/SerialBase.h b/drivers/SerialBase.h index 70c1d60c31..f6629fa520 100644 --- a/drivers/SerialBase.h +++ b/drivers/SerialBase.h @@ -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 - -/** @}*/ diff --git a/drivers/Ticker.h b/drivers/Ticker.h index 64044fecbe..844c14e083 100644 --- a/drivers/Ticker.h +++ b/drivers/Ticker.h @@ -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 - -/** @}*/ diff --git a/drivers/Timeout.h b/drivers/Timeout.h index 6fae2afd99..54240bf783 100644 --- a/drivers/Timeout.h +++ b/drivers/Timeout.h @@ -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 - -/** @}*/ diff --git a/drivers/Timer.h b/drivers/Timer.h index 2675eb5b51..51ed940966 100644 --- a/drivers/Timer.h +++ b/drivers/Timer.h @@ -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 - -/** @}*/ diff --git a/drivers/TimerEvent.h b/drivers/TimerEvent.h index 227b455923..b186c25b93 100644 --- a/drivers/TimerEvent.h +++ b/drivers/TimerEvent.h @@ -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 - -/** @}*/ diff --git a/events/Event.h b/events/Event.h index 7c4132af90..9e25a94279 100644 --- a/events/Event.h +++ b/events/Event.h @@ -21,11 +21,11 @@ namespace events { /** \addtogroup events */ -/** @{*/ /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event; @@ -33,6 +33,7 @@ class Event; /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template <> class Event { @@ -429,6 +430,7 @@ public: /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event { @@ -825,6 +827,7 @@ public: /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event { @@ -1221,6 +1224,7 @@ public: /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event { @@ -1617,6 +1621,7 @@ public: /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event { @@ -2013,6 +2018,7 @@ public: /** Event * * Representation of an event for fine-grain dispatch control + * @ingroup events */ template class Event { @@ -2407,6 +2413,8 @@ public: }; +/** \addtogroup events */ +/** @{ */ // Convenience functions declared here to avoid cyclic // dependency between Event and EventQueue diff --git a/events/EventQueue.h b/events/EventQueue.h index f87872fd5f..9695c1c827 100644 --- a/events/EventQueue.h +++ b/events/EventQueue.h @@ -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 -/** @}*/ diff --git a/platform/CThunk.h b/platform/CThunk.h index 1a9a17224b..d41bd76f02 100644 --- a/platform/CThunk.h +++ b/platform/CThunk.h @@ -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 CThunk @@ -242,4 +244,3 @@ class CThunk #endif/*__CTHUNK_H__*/ -/** @}*/ diff --git a/platform/CallChain.h b/platform/CallChain.h index 0a36cfe5c2..58ca6f8d5d 100644 --- a/platform/CallChain.h +++ b/platform/CallChain.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 *pFunctionPointer_t; @@ -189,4 +189,3 @@ private: #endif -/** @}*/ diff --git a/platform/Callback.h b/platform/Callback.h index e6462571a1..a03551eb25 100644 --- a/platform/Callback.h +++ b/platform/Callback.h @@ -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 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 class Callback { @@ -655,7 +656,8 @@ private: /** Callback class based on template specialization * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected + * @ingroup platform */ template class Callback { @@ -1250,7 +1252,8 @@ private: /** Callback class based on template specialization * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected + * @ingroup platform */ template class Callback { @@ -1845,7 +1848,8 @@ private: /** Callback class based on template specialization * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected + * @ingroup platform */ template class Callback { @@ -2440,7 +2444,8 @@ private: /** Callback class based on template specialization * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected + * @ingroup platform */ template class Callback { @@ -3035,7 +3040,8 @@ private: /** Callback class based on template specialization * - * @Note Synchronization level: Not protected + * @note Synchronization level: Not protected + * @ingroup platform */ template class Callback { @@ -4649,6 +4655,3 @@ Callback callback(const volatile U *obj, R (*func)(const } // namespace mbed #endif - - -/** @}*/ diff --git a/platform/CircularBuffer.h b/platform/CircularBuffer.h index c87c209101..97b1f6e593 100644 --- a/platform/CircularBuffer.h +++ b/platform/CircularBuffer.h @@ -20,11 +20,11 @@ namespace mbed { /** \addtogroup platform */ -/** @{*/ /** Templated Circular buffer class * * @Note Synchronization level: Interrupt safe + * @ingroup plaftorm */ template class CircularBuffer { @@ -116,4 +116,3 @@ private: #endif -/** @}*/ diff --git a/platform/DirHandle.h b/platform/DirHandle.h index 7478b62b80..8bdbd1dd61 100644 --- a/platform/DirHandle.h +++ b/platform/DirHandle.h @@ -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 */ - -/** @}*/ diff --git a/platform/FileBase.h b/platform/FileBase.h index 2101084cb7..9a451bb9bc 100644 --- a/platform/FileBase.h +++ b/platform/FileBase.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 -/** @}*/ diff --git a/platform/FileHandle.h b/platform/FileHandle.h index e131599600..cf6e3eb7e2 100644 --- a/platform/FileHandle.h +++ b/platform/FileHandle.h @@ -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 diff --git a/platform/FileLike.h b/platform/FileLike.h index a249b68c90..9c07c66ce9 100644 --- a/platform/FileLike.h +++ b/platform/FileLike.h @@ -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 diff --git a/platform/FilePath.h b/platform/FilePath.h index 9daa1597c6..377e3b6f4c 100644 --- a/platform/FilePath.h +++ b/platform/FilePath.h @@ -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 - -/** @}*/ diff --git a/platform/FileSystemLike.h b/platform/FileSystemLike.h index b9949c2a87..0d242a4fa7 100644 --- a/platform/FileSystemLike.h +++ b/platform/FileSystemLike.h @@ -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 - -/** @}*/ diff --git a/platform/FunctionPointer.h b/platform/FunctionPointer.h index 8d685479a1..a57195f7a8 100644 --- a/platform/FunctionPointer.h +++ b/platform/FunctionPointer.h @@ -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 class FunctionPointerArg1 : public Callback { public: @@ -59,6 +61,9 @@ public: } }; +/** + * @ingroup platform + */ template class FunctionPointerArg1 : public Callback { public: @@ -96,5 +101,3 @@ typedef FunctionPointerArg1 FunctionPointer; } // namespace mbed #endif - -/** @}*/ diff --git a/platform/LocalFileSystem.h b/platform/LocalFileSystem.h index 526c2d1f22..1b23024b27 100644 --- a/platform/LocalFileSystem.h +++ b/platform/LocalFileSystem.h @@ -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 -/** @}*/ diff --git a/platform/PlatformMutex.h b/platform/PlatformMutex.h index 19b0e7f790..3746ee80d7 100644 --- a/platform/PlatformMutex.h +++ b/platform/PlatformMutex.h @@ -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 -/** @}*/ diff --git a/platform/SingletonPtr.h b/platform/SingletonPtr.h index ea96b78917..b192e1056d 100644 --- a/platform/SingletonPtr.h +++ b/platform/SingletonPtr.h @@ -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 struct SingletonPtr { @@ -107,4 +109,3 @@ struct SingletonPtr { #endif -/** @}*/ diff --git a/platform/Stream.h b/platform/Stream.h index cbb25a9c61..865ad25d12 100644 --- a/platform/Stream.h +++ b/platform/Stream.h @@ -22,16 +22,18 @@ #include 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 -/** @}*/ diff --git a/platform/Transaction.h b/platform/Transaction.h index f866c89820..1967246d32 100644 --- a/platform/Transaction.h +++ b/platform/Transaction.h @@ -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 class Transaction { @@ -75,5 +76,3 @@ private: } #endif - -/** @}*/