Skip to content

Commit 5933dec

Browse files
committed
Harmonise Doxygen comments in drivers, events, platform and rtos dirs
When a Doxygen group has been defined (created), all its needed to add documentation to that group is `\addtogroup`. Since all the information about the group is preserved, it is not necessary to mention the group hierarchy again with `\ingroup`. This PR removes unnecessary Doxygen lines across the `drivers`, `events`, `platform` and `rtos` directories. It also ensures that new groups are created with `\defgroup` once and referenced with `\addtogroup` whenever documentation needs to be added to an existing group.
1 parent d8c2c6f commit 5933dec

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+176
-211
lines changed

drivers/AnalogIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
namespace mbed {
2929
/** \defgroup mbed-os-public Public API */
3030

31-
/** \addtogroup drivers-public-api Drivers
31+
/** \defgroup drivers-public-api Drivers
3232
* \ingroup mbed-os-public
3333
*/
3434

drivers/AnalogOut.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
#include "platform/PlatformMutex.h"
2626

2727
namespace mbed {
28-
/** \addtogroup drivers-public-api */
29-
3028
/**
3129
* \defgroup drivers_AnalogOut AnalogOut class
3230
* \ingroup drivers-public-api-gpio

drivers/Ethernet.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@
2323
#if DEVICE_ETHERNET || defined(DOXYGEN_ONLY)
2424

2525
namespace mbed {
26-
/** \ingroup mbed-os-public */
26+
2727
/** \addtogroup drivers-public-api */
2828
/** @{*/
29+
2930
/**
3031
* \defgroup drivers_Ethernet Ethernet class
3132
* @{

drivers/FlashIAP.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ extern uint32_t Load$$LR$$LR_IROM1$$Limit[];
4949

5050
namespace mbed {
5151

52-
/** \ingroup mbed-os-public */
5352
/** \addtogroup drivers-public-api */
5453
/** @{*/
54+
5555
/**
5656
* \defgroup drivers_FlashIAP FlashIAP class
5757
* @{

drivers/I2CSlave.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
namespace mbed {
2727
/**
28-
* \addtogroup drivers_I2CSlave I2CSlave class
28+
* \defgroup drivers_I2CSlave I2CSlave class
2929
* \ingroup drivers-public-api-i2c
3030
* @{
3131
*/

drivers/LowPowerTimeout.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
namespace mbed {
2929
/**
30-
* \addtogroup drivers_LowPowerTimeout LowPowerTimeout class
30+
* \defgroup drivers_LowPowerTimeout LowPowerTimeout class
3131
* \ingroup drivers-public-api-ticker
3232
* @{
3333
*/

drivers/LowPowerTimer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
namespace mbed {
2929
/**
30-
* \addtogroup drivers_LowPowerTimer LowPowerTimer class
30+
* \defgroup drivers_LowPowerTimer LowPowerTimer class
3131
* \ingroup drivers-public-api-ticker
3232
* @{
3333
*/

drivers/MbedCRC.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ but we check for ( width < 8) before performing shift, so it should not be an is
4040
#endif
4141

4242
namespace mbed {
43-
/** \ingroup mbed-os-public */
4443
/** \addtogroup drivers-public-api */
4544
/** @{*/
4645
/**

drivers/ResetReason.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
#include "reset_reason_api.h"
2323

2424
namespace mbed {
25-
/** \ingroup mbed-os-public */
2625
/** \addtogroup drivers-public-api */
2726
/** @{*/
27+
2828
/**
2929
* \defgroup drivers_ResetReason ResetReason class
3030
* @{

drivers/SPI.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646

4747
namespace mbed {
4848
/**
49-
* \addtogroup drivers_SPI SPI class
49+
* \defgroup drivers_SPI SPI class
5050
* \ingroup drivers-public-api-spi
5151
* @{
5252
*/

0 commit comments

Comments
 (0)