Skip to content

Commit f945d71

Browse files
committed
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.
1 parent b3ce996 commit f945d71

Some content is hidden

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

49 files changed

+100
-143
lines changed

drivers/AnalogIn.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626

2727
namespace mbed {
2828
/** \addtogroup drivers */
29-
/** @{*/
3029

3130
/** An analog input, used for reading the voltage on a pin
3231
*
@@ -48,6 +47,7 @@ namespace mbed {
4847
* }
4948
* }
5049
* @endcode
50+
* @ingroup drivers
5151
*/
5252
class AnalogIn {
5353

@@ -128,4 +128,3 @@ class AnalogIn {
128128

129129
#endif
130130

131-
/** @}*/

drivers/AnalogOut.h

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

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** @{*/
2928

3029
/** An analog output, used for setting the voltage on a pin
3130
*
@@ -48,6 +47,7 @@ namespace mbed {
4847
* }
4948
* }
5049
* @endcode
50+
* @ingroup drivers
5151
*/
5252
class AnalogOut {
5353

@@ -146,5 +146,3 @@ class AnalogOut {
146146
#endif
147147

148148
#endif
149-
150-
/** @}*/

drivers/BusIn.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222

2323
namespace mbed {
2424
/** \addtogroup drivers */
25-
/** @{*/
2625

2726
/** A digital input bus, used for reading the state of a collection of pins
2827
*
2928
* @note Synchronization level: Thread safe
29+
* @ingroup drivers
3030
*/
3131
class BusIn {
3232

@@ -125,4 +125,3 @@ class BusIn {
125125

126126
#endif
127127

128-
/** @}*/

drivers/BusInOut.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121

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

2625
/** A digital input output bus, used for setting the state of a collection of pins
2726
*
2827
* @note Synchronization level: Thread safe
28+
* @ingroup drivers
2929
*/
3030
class BusInOut {
3131

@@ -142,5 +142,3 @@ class BusInOut {
142142
} // namespace mbed
143143

144144
#endif
145-
146-
/** @}*/

drivers/BusOut.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121

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

2625
/** A digital output bus, used for setting the state of a collection of pins
26+
* @ingroup drivers
2727
*/
2828
class BusOut {
2929

@@ -126,5 +126,3 @@ class BusOut {
126126
} // namespace mbed
127127

128128
#endif
129-
130-
/** @}*/

drivers/CAN.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626

2727
namespace mbed {
2828
/** \addtogroup drivers */
29-
/** @{*/
3029

3130
/** CANMessage class
3231
*
3332
* @note Synchronization level: Thread safe
33+
* @ingroup drivers
3434
*/
3535
class CANMessage : public CAN_Message {
3636

@@ -67,6 +67,7 @@ class CANMessage : public CAN_Message {
6767
};
6868

6969
/** A can bus client, used for communicating with can devices
70+
* @ingroup drivers
7071
*/
7172
class CAN {
7273

@@ -259,4 +260,3 @@ class CAN {
259260

260261
#endif // MBED_CAN_H
261262

262-
/** @}*/

drivers/DigitalIn.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323

2424
namespace mbed {
2525
/** \addtogroup drivers */
26-
/** @{*/
2726

2827
/** A digital input, used for reading the state of a pin
2928
*
@@ -47,6 +46,7 @@ namespace mbed {
4746
* }
4847
* }
4948
* @endcode
49+
* @ingroup drivers
5050
*/
5151
class DigitalIn {
5252

@@ -115,5 +115,3 @@ class DigitalIn {
115115
} // namespace mbed
116116

117117
#endif
118-
119-
/** @}*/

drivers/DigitalInOut.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323

2424
namespace mbed {
2525
/** \addtogroup drivers */
26-
/** @{*/
2726

2827
/** A digital input/output, used for setting or reading a bi-directional pin
2928
*
3029
* @note Synchronization level: Interrupt safe
30+
* @ingroup drivers
3131
*/
3232
class DigitalInOut {
3333

@@ -140,5 +140,3 @@ class DigitalInOut {
140140
} // namespace mbed
141141

142142
#endif
143-
144-
/** @}*/

drivers/DigitalOut.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222

2323
namespace mbed {
2424
/** \addtogroup drivers */
25-
/** @{*/
2625

2726
/** A digital output, used for setting the state of a pin
2827
*
@@ -42,6 +41,7 @@ namespace mbed {
4241
* }
4342
* }
4443
* @endcode
44+
* @ingroup drivers
4545
*/
4646
class DigitalOut {
4747

@@ -126,5 +126,3 @@ class DigitalOut {
126126
} // namespace mbed
127127

128128
#endif
129-
130-
/** @}*/

drivers/Ethernet.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222

2323
namespace mbed {
2424
/** \addtogroup drivers */
25-
/** @{*/
2625

2726
/** An ethernet interface, to use with the ethernet pins.
2827
*
@@ -53,6 +52,7 @@ namespace mbed {
5352
* }
5453
* }
5554
* @endcode
55+
* @ingroup drivers
5656
*/
5757
class Ethernet {
5858

@@ -172,5 +172,3 @@ class Ethernet {
172172
#endif
173173

174174
#endif
175-
176-
/** @}*/

drivers/FlashIAP.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@
3131
namespace mbed {
3232

3333
/** \addtogroup drivers */
34-
/** @{*/
3534

3635
/** Flash IAP driver. It invokes flash HAL functions.
3736
*
3837
* @note Synchronization level: Thread safe
38+
* @ingroup drivers
3939
*/
4040
class FlashIAP {
4141
public:
@@ -134,5 +134,3 @@ class FlashIAP {
134134
#endif /* DEVICE_FLASH */
135135

136136
#endif /* MBED_FLASHIAP_H */
137-
138-
/** @}*/

drivers/I2C.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232

3333
namespace mbed {
3434
/** \addtogroup drivers */
35-
/** @{*/
3635

3736
/** An I2C Master, used for communicating with I2C slave devices
3837
*
@@ -52,6 +51,7 @@ namespace mbed {
5251
* i2c.read(address, data, 2);
5352
* }
5453
* @endcode
54+
* @ingroup drivers
5555
*/
5656
class I2C {
5757

@@ -194,5 +194,3 @@ class I2C {
194194
#endif
195195

196196
#endif
197-
198-
/** @}*/

drivers/I2CSlave.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424

2525
namespace mbed {
2626
/** \addtogroup drivers */
27-
/** @{*/
2827

2928
/** An I2C Slave, used for communicating with an I2C Master device
3029
*
@@ -61,6 +60,7 @@ namespace mbed {
6160
* }
6261
* }
6362
* @endcode
63+
* @ingroup drivers
6464
*/
6565
class I2CSlave {
6666

@@ -156,5 +156,3 @@ class I2CSlave {
156156
#endif
157157

158158
#endif
159-
160-
/** @}*/

drivers/InterruptIn.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828

2929
namespace mbed {
3030
/** \addtogroup drivers */
31-
/** @{*/
3231

3332
/** A digital interrupt input, used to call a function on a rising or falling edge
3433
*
@@ -55,6 +54,7 @@ namespace mbed {
5554
* }
5655
* }
5756
* @endcode
57+
* @ingroup drivers
5858
*/
5959
class InterruptIn {
6060

@@ -159,5 +159,3 @@ class InterruptIn {
159159
#endif
160160

161161
#endif
162-
163-
/** @}*/

drivers/InterruptManager.h

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323

2424
namespace mbed {
2525
/** \addtogroup drivers */
26-
/** @{*/
2726

2827
/** Use this singleton if you need to chain interrupt handlers.
2928
*
@@ -52,6 +51,7 @@ namespace mbed {
5251
* InterruptManager::get()->add_handler(handler, TIMER3_IRQn);
5352
* }
5453
* @endcode
54+
* @ingroup drivers
5555
*/
5656
class InterruptManager {
5757
public:
@@ -170,6 +170,3 @@ class InterruptManager {
170170
} // namespace mbed
171171

172172
#endif
173-
174-
175-
/** @}*/

drivers/LowPowerTicker.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** @{*/
2928

3029
/** Low Power Ticker
3130
*
3231
* @note Synchronization level: Interrupt safe
32+
* @ingroup drivers
3333
*/
3434
class LowPowerTicker : public Ticker {
3535

@@ -46,5 +46,3 @@ class LowPowerTicker : public Ticker {
4646
#endif
4747

4848
#endif
49-
50-
/** @}*/

drivers/LowPowerTimeout.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** @{*/
2928

3029
/** Low Power Timout
3130
*
3231
* @note Synchronization level: Interrupt safe
32+
* @ingroup drivers
3333
*/
3434
class LowPowerTimeout : public LowPowerTicker {
3535

@@ -44,5 +44,3 @@ class LowPowerTimeout : public LowPowerTicker {
4444
#endif
4545

4646
#endif
47-
48-
/** @}*/

drivers/LowPowerTimer.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@
2525

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** @{*/
2928

3029
/** Low power timer
3130
*
3231
* @note Synchronization level: Interrupt safe
32+
* @ingroup drivers
3333
*/
3434
class LowPowerTimer : public Timer {
3535

@@ -44,5 +44,3 @@ class LowPowerTimer : public Timer {
4444
#endif
4545

4646
#endif
47-
48-
/** @}*/

drivers/PortIn.h

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

2626
namespace mbed {
2727
/** \addtogroup drivers */
28-
/** @{*/
2928

3029
/** A multiple pin digital input
3130
*
@@ -51,6 +50,7 @@ namespace mbed {
5150
* }
5251
* }
5352
* @endcode
53+
* @ingroup drivers
5454
*/
5555
class PortIn {
5656
public:
@@ -100,5 +100,3 @@ class PortIn {
100100
#endif
101101

102102
#endif
103-
104-
/** @}*/

0 commit comments

Comments
 (0)