Skip to content

Commit 20f81e1

Browse files
hugueskambaevedon
hugueskamba
authored and
evedon
committed
Change Doxygen groups structure, splitting first by Public/Internal (#11105)
* Change Doxygen groups structure, splitting first by Public/Internal This commit also does the following: * groups the documentation of related API * moves `events/internal/equeue.h` to `events/equeue.h` * merges `events/source/README.md` to `events/README.md`
1 parent c6b0a14 commit 20f81e1

File tree

135 files changed

+474
-569
lines changed

Some content is hidden

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

135 files changed

+474
-569
lines changed

‎UNITTESTS/target_h/drivers/LowPowerTicker.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
#include "Callback.h"
2222

2323
namespace mbed {
24-
/** \addtogroup drivers */
2524

2625
/** mock Low Power Ticker
2726
*

‎drivers/AnalogIn.h

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,19 @@
2626
#include "platform/PlatformMutex.h"
2727

2828
namespace mbed {
29-
/** \ingroup drivers */
30-
/** \addtogroup drivers-public-api Public API */
31-
/** @{*/
29+
/** \defgroup mbed-os-public Public API */
30+
31+
/** \addtogroup drivers-public-api Drivers
32+
* \ingroup mbed-os-public
33+
*/
34+
35+
/** \defgroup drivers-public-api-gpio GPIO
36+
* \ingroup drivers-public-api
37+
*/
38+
3239
/**
3340
* \defgroup drivers_AnalogIn AnalogIn class
41+
* \ingroup drivers-public-api-gpio
3442
* @{
3543
*/
3644

@@ -120,7 +128,6 @@ class AnalogIn {
120128

121129
};
122130

123-
/** @}*/
124131
/** @}*/
125132

126133
} // namespace mbed

‎drivers/AnalogOut.h

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

2727
namespace mbed {
28-
/** \ingroup drivers */
2928
/** \addtogroup drivers-public-api */
30-
/** @{*/
29+
3130
/**
3231
* \defgroup drivers_AnalogOut AnalogOut class
32+
* \ingroup drivers-public-api-gpio
3333
* @{
3434
*/
3535

@@ -147,7 +147,6 @@ class AnalogOut {
147147
#endif //!defined(DOXYGEN_ONLY)
148148
};
149149

150-
/** @}*/
151150
/** @}*/
152151

153152
} // namespace mbed

‎drivers/BusIn.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@
2323
#include "platform/NonCopyable.h"
2424

2525
namespace mbed {
26-
/** \ingroup drivers */
27-
/** \addtogroup drivers-public-api */
28-
/** @{*/
26+
/** \defgroup drivers-public-api-bus Bus
27+
* \ingroup drivers-public-api
28+
*/
29+
2930
/**
3031
* \defgroup drivers_BusIn BusIn class
32+
* \ingroup drivers-public-api-bus
3133
* @{
3234
*/
3335

@@ -130,7 +132,6 @@ class BusIn : private NonCopyable<BusIn> {
130132
#endif
131133
};
132134

133-
/** @}*/
134135
/** @}*/
135136

136137
} // namespace mbed

‎drivers/BusInOut.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@
2222
#include "platform/NonCopyable.h"
2323

2424
namespace mbed {
25-
/** \ingroup drivers */
26-
/** \addtogroup drivers-public-api */
27-
/** @{*/
2825
/**
2926
* \defgroup drivers_BusInOut BusInOut class
27+
* \ingroup drivers-public-api-bus
3028
* @{
3129
*/
3230

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

155-
/** @}*/
156153
/** @}*/
157154

158155
} // namespace mbed

‎drivers/BusOut.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@
2222
#include "platform/NonCopyable.h"
2323

2424
namespace mbed {
25-
/** \ingroup drivers */
26-
/** \addtogroup drivers-public-api */
27-
/** @{*/
2825
/**
2926
* \defgroup drivers_BusOut BusOut class
27+
* \ingroup drivers-public-api-bus
3028
* @{
3129
*/
3230

@@ -130,7 +128,6 @@ class BusOut : private NonCopyable<BusOut> {
130128
#endif
131129
};
132130

133-
/** @}*/
134131
/** @}*/
135132

136133
} // namespace mbed

‎drivers/CAN.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@
2727
#include "platform/NonCopyable.h"
2828

2929
namespace mbed {
30-
/** \ingroup drivers */
31-
/** \addtogroup drivers-public-api */
32-
/** @{*/
30+
/** \defgroup drivers-public-api-can CAN
31+
* \ingroup drivers-public-api
32+
*/
33+
3334
/**
3435
* \defgroup drivers_CANMessage CANMessage class
36+
* \ingroup drivers-public-api-can
3537
* @{
3638
*/
3739

@@ -107,6 +109,7 @@ class CANMessage : public CAN_Message {
107109

108110
/**
109111
* \defgroup drivers_CAN CAN class
112+
* \ingroup drivers-public-api-can
110113
* @{
111114
*/
112115

@@ -333,7 +336,6 @@ class CAN : private NonCopyable<CAN> {
333336
#endif
334337
};
335338

336-
/** @}*/
337339
/** @}*/
338340

339341
} // namespace mbed

‎drivers/DigitalIn.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@
2222
#include "hal/gpio_api.h"
2323

2424
namespace mbed {
25-
/** \ingroup drivers */
26-
/** \addtogroup drivers-public-api */
27-
/** @{*/
2825
/**
2926
* \defgroup drivers_DigitalIn DigitalIn class
27+
* \ingroup drivers-public-api-gpio
3028
* @{
3129
*/
3230

@@ -127,7 +125,6 @@ class DigitalIn {
127125
#endif //!defined(DOXYGEN_ONLY)
128126
};
129127

130-
/** @}*/
131128
/** @}*/
132129

133130
} // namespace mbed

‎drivers/DigitalInOut.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@
2222
#include "hal/gpio_api.h"
2323

2424
namespace mbed {
25-
/** \ingroup drivers */
26-
/** \addtogroup drivers-public-api */
27-
/** @{*/
2825
/**
2926
* \defgroup drivers_DigitalInOut DigitalInOut class
27+
* \ingroup drivers-public-api-gpio
3028
* @{
3129
*/
3230

@@ -154,7 +152,6 @@ class DigitalInOut {
154152
#endif //!defined(DOXYGEN_ONLY)
155153
};
156154

157-
/** @}*/
158155
/** @}*/
159156

160157
} // namespace mbed

‎drivers/DigitalOut.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,9 @@
2121
#include "hal/gpio_api.h"
2222

2323
namespace mbed {
24-
/** \ingroup drivers */
25-
/** \addtogroup drivers-public-api */
26-
/** @{*/
2724
/**
2825
* \defgroup drivers_DigitalOut DigitalOut class
26+
* \ingroup drivers-public-api-gpio
2927
* @{
3028
*/
3129

@@ -148,7 +146,6 @@ class DigitalOut {
148146
#endif //!defined(DOXYGEN_ONLY)
149147
};
150148

151-
/** @}*/
152149
/** @}*/
153150

154151
} // namespace mbed

‎drivers/Ethernet.h

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

2525
namespace mbed {
26-
/** \ingroup drivers */
26+
/** \ingroup mbed-os-public */
2727
/** \addtogroup drivers-public-api */
2828
/** @{*/
2929
/**

‎drivers/FlashIAP.h

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

5050
namespace mbed {
5151

52-
/** \ingroup drivers */
52+
/** \ingroup mbed-os-public */
5353
/** \addtogroup drivers-public-api */
5454
/** @{*/
5555
/**

‎drivers/I2C.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,13 @@
3434
#endif
3535

3636
namespace mbed {
37-
/** \ingroup drivers */
38-
/** \addtogroup drivers-public-api */
39-
/** @{*/
37+
/** \defgroup drivers-public-api-i2c I2C
38+
* \ingroup drivers-public-api
39+
*/
40+
4041
/**
4142
* \defgroup drivers_I2C I2C class
43+
* \ingroup drivers-public-api-i2c
4244
* @{
4345
*/
4446

@@ -247,7 +249,6 @@ class I2C : private NonCopyable<I2C> {
247249
#endif
248250
};
249251

250-
/** @}*/
251252
/** @}*/
252253

253254
} // namespace mbed

‎drivers/I2CSlave.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@
2424
#include "hal/i2c_api.h"
2525

2626
namespace mbed {
27-
/** \ingroup drivers */
28-
/** \addtogroup drivers-public-api */
29-
/** @{*/
3027
/**
31-
* \defgroup drivers_I2CSlave I2CSlave class
28+
* \addtogroup drivers_I2CSlave I2CSlave class
29+
* \ingroup drivers-public-api-i2c
3230
* @{
3331
*/
3432

@@ -165,7 +163,6 @@ class I2CSlave {
165163
#endif //!defined(DOXYGEN_ONLY)
166164
};
167165

168-
/** @}*/
169166
/** @}*/
170167

171168
} // namespace mbed

‎drivers/InterruptIn.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,13 @@
2929
#include "platform/NonCopyable.h"
3030

3131
namespace mbed {
32-
/** \ingroup drivers */
33-
/** \addtogroup drivers-public-api */
34-
/** @{*/
32+
/** \defgroup drivers-public-api-interrupt Interrupt
33+
* \ingroup drivers-public-api
34+
*/
35+
3536
/**
3637
* \defgroup drivers_InterruptIn InterruptIn class
38+
* \ingroup drivers-public-api-interrupt
3739
* @{
3840
*/
3941

@@ -180,7 +182,6 @@ class InterruptIn : private NonCopyable<InterruptIn> {
180182
#endif
181183
};
182184

183-
/** @}*/
184185
/** @}*/
185186

186187
} // namespace mbed

‎drivers/InterruptManager.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,9 @@
2424
#include <string.h>
2525

2626
namespace mbed {
27-
/** \ingroup drivers */
28-
/** \addtogroup drivers-public-api */
29-
/** @{*/
3027
/**
3128
* \defgroup drivers_InterruptManager InterruptManager class
29+
* \ingroup drivers-public-api-interrupt
3230
* @{
3331
*/
3432

@@ -209,7 +207,6 @@ class InterruptManager : private NonCopyable<InterruptManager> {
209207
#endif
210208
};
211209

212-
/** @}*/
213210
/** @}*/
214211

215212
} // namespace mbed

‎drivers/LowPowerTicker.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@
2626
#include "hal/lp_ticker_api.h"
2727

2828
namespace mbed {
29-
/** \ingroup drivers */
30-
/** \addtogroup drivers-public-api */
31-
/** @{*/
29+
/** \defgroup drivers-public-api-ticker Ticker
30+
* \ingroup drivers-public-api
31+
*/
32+
3233
/**
3334
* \defgroup drivers_LowPowerTicker LowPowerTicker class
35+
* \ingroup drivers-public-api-ticker
3436
* @{
3537
*/
3638

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

53-
/** @}*/
5455
/** @}*/
5556

5657
} // namespace mbed

‎drivers/LowPowerTimeout.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@
2626
#include "platform/NonCopyable.h"
2727

2828
namespace mbed {
29-
/** \ingroup drivers */
30-
/** \addtogroup drivers-public-api */
31-
/** @{*/
3229
/**
33-
* \defgroup drivers_LowPowerTimeout LowPowerTimeout class
30+
* \addtogroup drivers_LowPowerTimeout LowPowerTimeout class
31+
* \ingroup drivers-public-api-ticker
3432
* @{
3533
*/
3634

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

51-
/** @}*/
5249
/** @}*/
5350

5451
} // namespace mbed

0 commit comments

Comments
 (0)