Skip to content

Commit 47b1a9e

Browse files
adbridgeadbridge
authored
Merge pull request #4111 from sg-/fix-the-docs
[drivers] Update doxygen errors
2 parents cf87e7d + 5f9f8c5 commit 47b1a9e

Some content is hidden

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

50 files changed

+271
-233
lines changed

‎doxygen_options.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"ENABLE_PREPROCESSING": "YES",
3+
"MACRO_EXPANSION": "YES",
4+
"EXPAND_ONLY_PREDEF": "NO",
5+
"SEARCH_INCLUDES": "YES",
6+
"INCLUDE_PATH": "",
7+
"INCLUDE_FILE_PATTERNS": "",
8+
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\"",
9+
"EXPAND_AS_DEFINED": "",
10+
"SKIP_FUNCTION_MACROS": "NO",
11+
"EXCLUDE_PATTERNS": "*/targets/* */features/FEATURE_*/* */features/mbedtls/* */features/nanostack/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/fat/* */BUILD/* */rtos/* */events/* */platform/* */cmsis/* */hal/* */features/*"
12+
}

‎drivers/AnalogIn.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,18 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_ANALOGIN
21+
#if defined (DEVICE_ANALOGIN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/analogin_api.h"
2424
#include "platform/SingletonPtr.h"
2525
#include "platform/PlatformMutex.h"
2626

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

3130
/** An analog input, used for reading the voltage on a pin
3231
*
33-
* @Note Synchronization level: Thread safe
32+
* @note Synchronization level: Thread safe
3433
*
3534
* Example:
3635
* @code
@@ -48,6 +47,7 @@ namespace mbed {
4847
* }
4948
* }
5049
* @endcode
50+
* @ingroup drivers
5151
*/
5252
class AnalogIn {
5353

@@ -56,7 +56,6 @@ class AnalogIn {
5656
/** Create an AnalogIn, connected to the specified pin
5757
*
5858
* @param pin AnalogIn pin to connect to
59-
* @param name (optional) A string to identify the object
6059
*/
6160
AnalogIn(PinName pin) {
6261
lock();
@@ -129,4 +128,3 @@ class AnalogIn {
129128

130129
#endif
131130

132-
/** @}*/

‎drivers/AnalogOut.h

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,17 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_ANALOGOUT
21+
#if defined (DEVICE_ANALOGOUT) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/analogout_api.h"
2424
#include "platform/PlatformMutex.h"
2525

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

3029
/** An analog output, used for setting the voltage on a pin
3130
*
32-
* @Note Synchronization level: Thread safe
31+
* @note Synchronization level: Thread safe
3332
*
3433
* Example:
3534
* @code
@@ -48,14 +47,15 @@ namespace mbed {
4847
* }
4948
* }
5049
* @endcode
50+
* @ingroup drivers
5151
*/
5252
class AnalogOut {
5353

5454
public:
5555

5656
/** Create an AnalogOut connected to the specified pin
5757
*
58-
* @param AnalogOut pin to connect to (18)
58+
* @param pin AnalogOut pin to connect to
5959
*/
6060
AnalogOut(PinName pin) {
6161
analogout_init(&_dac, pin);
@@ -146,5 +146,3 @@ class AnalogOut {
146146
#endif
147147

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

‎drivers/BusIn.h

Lines changed: 26 additions & 7 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
*
29-
* @Note Synchronization level: Thread safe
28+
* @note Synchronization level: Thread safe
29+
* @ingroup drivers
3030
*/
3131
class BusIn {
3232

@@ -35,7 +35,22 @@ class BusIn {
3535

3636
/** Create an BusIn, connected to the specified pins
3737
*
38-
* @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
38+
* @param p0 DigitalIn pin to connect to bus bit
39+
* @param p1 DigitalIn pin to connect to bus bit
40+
* @param p2 DigitalIn pin to connect to bus bit
41+
* @param p3 DigitalIn pin to connect to bus bit
42+
* @param p4 DigitalIn pin to connect to bus bit
43+
* @param p5 DigitalIn pin to connect to bus bit
44+
* @param p6 DigitalIn pin to connect to bus bit
45+
* @param p7 DigitalIn pin to connect to bus bit
46+
* @param p8 DigitalIn pin to connect to bus bit
47+
* @param p9 DigitalIn pin to connect to bus bit
48+
* @param p10 DigitalIn pin to connect to bus bit
49+
* @param p11 DigitalIn pin to connect to bus bit
50+
* @param p12 DigitalIn pin to connect to bus bit
51+
* @param p13 DigitalIn pin to connect to bus bit
52+
* @param p14 DigitalIn pin to connect to bus bit
53+
* @param p15 DigitalIn pin to connect to bus bit
3954
*
4055
* @note
4156
* It is only required to specify as many pin variables as is required
@@ -46,7 +61,12 @@ class BusIn {
4661
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
4762
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
4863

49-
BusIn(PinName pins[16]);
64+
65+
/** Create an BusIn, connected to the specified pins
66+
*
67+
* @param pins An array of pins to connect to bus bit
68+
*/
69+
BusIn(PinName pins[16]);
5070

5171
virtual ~BusIn();
5272

@@ -59,7 +79,7 @@ class BusIn {
5979

6080
/** Set the input pin mode
6181
*
62-
* @param mode PullUp, PullDown, PullNone
82+
* @param pull PullUp, PullDown, PullNone
6383
*/
6484
void mode(PinMode pull);
6585

@@ -85,7 +105,7 @@ class BusIn {
85105
protected:
86106
DigitalIn* _pin[16];
87107

88-
/** Mask of bus's NC pins
108+
/* Mask of bus's NC pins
89109
* If bit[n] is set to 1 - pin is connected
90110
* if bit[n] is cleared - pin is not connected (NC)
91111
*/
@@ -105,4 +125,3 @@ class BusIn {
105125

106126
#endif
107127

108-
/** @}*/

‎drivers/BusInOut.h

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,34 @@
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
*
28-
* @Note Synchronization level: Thread safe
27+
* @note Synchronization level: Thread safe
28+
* @ingroup drivers
2929
*/
3030
class BusInOut {
3131

3232
public:
3333

3434
/** Create an BusInOut, connected to the specified pins
3535
*
36-
* @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
36+
* @param p0 DigitalInOut pin to connect to bus bit
37+
* @param p1 DigitalInOut pin to connect to bus bit
38+
* @param p2 DigitalInOut pin to connect to bus bit
39+
* @param p3 DigitalInOut pin to connect to bus bit
40+
* @param p4 DigitalInOut pin to connect to bus bit
41+
* @param p5 DigitalInOut pin to connect to bus bit
42+
* @param p6 DigitalInOut pin to connect to bus bit
43+
* @param p7 DigitalInOut pin to connect to bus bit
44+
* @param p8 DigitalInOut pin to connect to bus bit
45+
* @param p9 DigitalInOut pin to connect to bus bit
46+
* @param p10 DigitalInOut pin to connect to bus bit
47+
* @param p11 DigitalInOut pin to connect to bus bit
48+
* @param p12 DigitalInOut pin to connect to bus bit
49+
* @param p13 DigitalInOut pin to connect to bus bit
50+
* @param p14 DigitalInOut pin to connect to bus bit
51+
* @param p15 DigitalInOut pin to connect to bus bit
3752
*
3853
* @note
3954
* It is only required to specify as many pin variables as is required
@@ -44,6 +59,10 @@ class BusInOut {
4459
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
4560
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
4661

62+
/** Create an BusInOut, connected to the specified pins
63+
*
64+
* @param pins An array of pins to construct a BusInOut from
65+
*/
4766
BusInOut(PinName pins[16]);
4867

4968
virtual ~BusInOut();
@@ -73,7 +92,7 @@ class BusInOut {
7392

7493
/** Set the input pin mode
7594
*
76-
* @param mode PullUp, PullDown, PullNone
95+
* @param pull PullUp, PullDown, PullNone
7796
*/
7897
void mode(PinMode pull);
7998

@@ -106,7 +125,7 @@ class BusInOut {
106125
virtual void unlock();
107126
DigitalInOut* _pin[16];
108127

109-
/** Mask of bus's NC pins
128+
/* Mask of bus's NC pins
110129
* If bit[n] is set to 1 - pin is connected
111130
* if bit[n] is cleared - pin is not connected (NC)
112131
*/
@@ -123,5 +142,3 @@ class BusInOut {
123142
} // namespace mbed
124143

125144
#endif
126-
127-
/** @}*/

‎drivers/BusOut.h

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,34 @@
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

3030
public:
3131

3232
/** Create an BusOut, connected to the specified pins
3333
*
34-
* @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
34+
* @param p0 DigitalOut pin to connect to bus bit
35+
* @param p1 DigitalOut pin to connect to bus bit
36+
* @param p2 DigitalOut pin to connect to bus bit
37+
* @param p3 DigitalOut pin to connect to bus bit
38+
* @param p4 DigitalOut pin to connect to bus bit
39+
* @param p5 DigitalOut pin to connect to bus bit
40+
* @param p6 DigitalOut pin to connect to bus bit
41+
* @param p7 DigitalOut pin to connect to bus bit
42+
* @param p8 DigitalOut pin to connect to bus bit
43+
* @param p9 DigitalOut pin to connect to bus bit
44+
* @param p10 DigitalOut pin to connect to bus bit
45+
* @param p11 DigitalOut pin to connect to bus bit
46+
* @param p12 DigitalOut pin to connect to bus bit
47+
* @param p13 DigitalOut pin to connect to bus bit
48+
* @param p14 DigitalOut pin to connect to bus bit
49+
* @param p15 DigitalOut pin to connect to bus bit
3550
*
36-
* @Note Synchronization level: Thread safe
51+
* @note Synchronization level: Thread safe
3752
*
3853
* @note
3954
* It is only required to specify as many pin variables as is required
@@ -44,6 +59,10 @@ class BusOut {
4459
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
4560
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
4661

62+
/** Create an BusOut, connected to the specified pins
63+
*
64+
* @param pins An array of pins to connect to bus the bit
65+
*/
4766
BusOut(PinName pins[16]);
4867

4968
virtual ~BusOut();
@@ -90,7 +109,7 @@ class BusOut {
90109
virtual void unlock();
91110
DigitalOut* _pin[16];
92111

93-
/** Mask of bus's NC pins
112+
/* Mask of bus's NC pins
94113
* If bit[n] is set to 1 - pin is connected
95114
* if bit[n] is cleared - pin is not connected (NC)
96115
*/
@@ -107,5 +126,3 @@ class BusOut {
107126
} // namespace mbed
108127

109128
#endif
110-
111-
/** @}*/

‎drivers/CAN.h

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@
1818

1919
#include "platform/platform.h"
2020

21-
#if DEVICE_CAN
21+
#if defined (DEVICE_CAN) || defined(DOXYGEN_ONLY)
2222

2323
#include "hal/can_api.h"
2424
#include "platform/Callback.h"
2525
#include "platform/PlatformMutex.h"
2626

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

3130
/** CANMessage class
3231
*
33-
* @Note Synchronization level: Thread safe
32+
* @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

@@ -213,7 +214,7 @@ class CAN {
213214
* generated.
214215
*
215216
* @param func A pointer to a void function, or 0 to set as none
216-
* @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, CAN::TxIrq for transmitted or aborted, CAN::EwIrq for error warning, CAN::DoIrq for data overrun, CAN::WuIrq for wake-up, CAN::EpIrq for error passive, CAN::AlIrq for arbitration lost, CAN::BeIrq for bus error)
217+
* @param type Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, CAN::TxIrq for transmitted or aborted, CAN::EwIrq for error warning, CAN::DoIrq for data overrun, CAN::WuIrq for wake-up, CAN::EpIrq for error passive, CAN::AlIrq for arbitration lost, CAN::BeIrq for bus error)
217218
*/
218219
void attach(Callback<void()> func, IrqType type=RxIrq);
219220

@@ -222,25 +223,37 @@ class CAN {
222223
*
223224
* @param obj pointer to the object to call the member function on
224225
* @param method pointer to the member function to be called
225-
* @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
226+
* @param type Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
227+
* @deprecated
228+
* The attach function does not support cv-qualifiers. Replaced by
229+
* attach(callback(obj, method), type).
226230
*/
227231
template<typename T>
232+
MBED_DEPRECATED_SINCE("mbed-os-5.1",
233+
"The attach function does not support cv-qualifiers. Replaced by "
234+
"attach(callback(obj, method), type).")
228235
void attach(T* obj, void (T::*method)(), IrqType type=RxIrq) {
229236
// Underlying call thread safe
230-
attach(Callback<void()>(obj, method), type);
237+
attach(callback(obj, method), type);
231238
}
232239

233240
/** Attach a member function to call whenever a CAN frame received interrupt
234241
* is generated.
235242
*
236243
* @param obj pointer to the object to call the member function on
237244
* @param method pointer to the member function to be called
238-
* @param event Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
245+
* @param type Which CAN interrupt to attach the member function to (CAN::RxIrq for message received, TxIrq for transmitted or aborted, EwIrq for error warning, DoIrq for data overrun, WuIrq for wake-up, EpIrq for error passive, AlIrq for arbitration lost, BeIrq for bus error)
246+
* @deprecated
247+
* The attach function does not support cv-qualifiers. Replaced by
248+
* attach(callback(obj, method), type).
239249
*/
240250
template<typename T>
251+
MBED_DEPRECATED_SINCE("mbed-os-5.1",
252+
"The attach function does not support cv-qualifiers. Replaced by "
253+
"attach(callback(obj, method), type).")
241254
void attach(T* obj, void (*method)(T*), IrqType type=RxIrq) {
242255
// Underlying call thread safe
243-
attach(Callback<void()>(obj, method), type);
256+
attach(callback(obj, method), type);
244257
}
245258

246259
static void _irq_handler(uint32_t id, CanIrqType type);
@@ -259,4 +272,3 @@ class CAN {
259272

260273
#endif // MBED_CAN_H
261274

262-
/** @}*/

0 commit comments

Comments
 (0)