Skip to content

Change Doxygen groups structure, splitting first by Public/Internal #11105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 24, 2019
Merged

Change Doxygen groups structure, splitting first by Public/Internal #11105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e843a3
Change Doxygen groups structure, splitting first by Public/Internal
hugueskamba Jul 23, 2019
46ffaba
Removed space at end of line
evedon Jul 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion UNITTESTS/target_h/drivers/LowPowerTicker.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#include "Callback.h"

namespace mbed {
/** \addtogroup drivers */

/** mock Low Power Ticker
*
Expand Down
15 changes: 11 additions & 4 deletions drivers/AnalogIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,19 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api Public API */
/** @{*/
/** \defgroup mbed-os-public Public API */

/** \addtogroup drivers-public-api Drivers
* \ingroup mbed-os-public
*/

/** \defgroup drivers-public-api-gpio GPIO
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_AnalogIn AnalogIn class
* \ingroup drivers-public-api-gpio
* @{
*/

Expand Down Expand Up @@ -120,7 +128,6 @@ class AnalogIn {

};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 2 additions & 3 deletions drivers/AnalogOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/

/**
* \defgroup drivers_AnalogOut AnalogOut class
* \ingroup drivers-public-api-gpio
* @{
*/

Expand Down Expand Up @@ -147,7 +147,6 @@ class AnalogOut {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
9 changes: 5 additions & 4 deletions drivers/BusIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/** \defgroup drivers-public-api-bus Bus
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_BusIn BusIn class
* \ingroup drivers-public-api-bus
* @{
*/

Expand Down Expand Up @@ -130,7 +132,6 @@ class BusIn : private NonCopyable<BusIn> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/BusInOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_BusInOut BusInOut class
* \ingroup drivers-public-api-bus
* @{
*/

Expand Down Expand Up @@ -152,7 +150,6 @@ class BusInOut : private NonCopyable<BusInOut> {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/BusOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_BusOut BusOut class
* \ingroup drivers-public-api-bus
* @{
*/

Expand Down Expand Up @@ -130,7 +128,6 @@ class BusOut : private NonCopyable<BusOut> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
10 changes: 6 additions & 4 deletions drivers/CAN.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/** \defgroup drivers-public-api-can CAN
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_CANMessage CANMessage class
* \ingroup drivers-public-api-can
* @{
*/

Expand Down Expand Up @@ -107,6 +109,7 @@ class CANMessage : public CAN_Message {

/**
* \defgroup drivers_CAN CAN class
* \ingroup drivers-public-api-can
* @{
*/

Expand Down Expand Up @@ -333,7 +336,6 @@ class CAN : private NonCopyable<CAN> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/DigitalIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
#include "hal/gpio_api.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_DigitalIn DigitalIn class
* \ingroup drivers-public-api-gpio
* @{
*/

Expand Down Expand Up @@ -127,7 +125,6 @@ class DigitalIn {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/DigitalInOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
#include "hal/gpio_api.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_DigitalInOut DigitalInOut class
* \ingroup drivers-public-api-gpio
* @{
*/

Expand Down Expand Up @@ -154,7 +152,6 @@ class DigitalInOut {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/DigitalOut.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@
#include "hal/gpio_api.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_DigitalOut DigitalOut class
* \ingroup drivers-public-api-gpio
* @{
*/

Expand Down Expand Up @@ -148,7 +146,6 @@ class DigitalOut {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
2 changes: 1 addition & 1 deletion drivers/Ethernet.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#if DEVICE_ETHERNET || defined(DOXYGEN_ONLY)

namespace mbed {
/** \ingroup drivers */
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**
Expand Down
2 changes: 1 addition & 1 deletion drivers/FlashIAP.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ extern uint32_t Load$$LR$$LR_IROM1$$Limit[];

namespace mbed {

/** \ingroup drivers */
/** \ingroup mbed-os-public */
/** \addtogroup drivers-public-api */
/** @{*/
/**
Expand Down
9 changes: 5 additions & 4 deletions drivers/I2C.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,13 @@
#endif

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/** \defgroup drivers-public-api-i2c I2C
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_I2C I2C class
* \ingroup drivers-public-api-i2c
* @{
*/

Expand Down Expand Up @@ -247,7 +249,6 @@ class I2C : private NonCopyable<I2C> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
7 changes: 2 additions & 5 deletions drivers/I2CSlave.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@
#include "hal/i2c_api.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_I2CSlave I2CSlave class
* \addtogroup drivers_I2CSlave I2CSlave class
* \ingroup drivers-public-api-i2c
* @{
*/

Expand Down Expand Up @@ -165,7 +163,6 @@ class I2CSlave {
#endif //!defined(DOXYGEN_ONLY)
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
9 changes: 5 additions & 4 deletions drivers/InterruptIn.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,13 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/** \defgroup drivers-public-api-interrupt Interrupt
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_InterruptIn InterruptIn class
* \ingroup drivers-public-api-interrupt
* @{
*/

Expand Down Expand Up @@ -180,7 +182,6 @@ class InterruptIn : private NonCopyable<InterruptIn> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
5 changes: 1 addition & 4 deletions drivers/InterruptManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@
#include <string.h>

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_InterruptManager InterruptManager class
* \ingroup drivers-public-api-interrupt
* @{
*/

Expand Down Expand Up @@ -209,7 +207,6 @@ class InterruptManager : private NonCopyable<InterruptManager> {
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
9 changes: 5 additions & 4 deletions drivers/LowPowerTicker.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,13 @@
#include "hal/lp_ticker_api.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/** \defgroup drivers-public-api-ticker Ticker
* \ingroup drivers-public-api
*/

/**
* \defgroup drivers_LowPowerTicker LowPowerTicker class
* \ingroup drivers-public-api-ticker
* @{
*/

Expand All @@ -50,7 +52,6 @@ class LowPowerTicker : public Ticker, private NonCopyable<LowPowerTicker> {
}
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
7 changes: 2 additions & 5 deletions drivers/LowPowerTimeout.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@
#include "platform/NonCopyable.h"

namespace mbed {
/** \ingroup drivers */
/** \addtogroup drivers-public-api */
/** @{*/
/**
* \defgroup drivers_LowPowerTimeout LowPowerTimeout class
* \addtogroup drivers_LowPowerTimeout LowPowerTimeout class
* \ingroup drivers-public-api-ticker
* @{
*/

Expand All @@ -48,7 +46,6 @@ class LowPowerTimeout : public LowPowerTicker, private NonCopyable<LowPowerTimeo
#endif
};

/** @}*/
/** @}*/

} // namespace mbed
Expand Down
Loading