Skip to content

Commit b3ce996

Browse files
sg-sg-
committed
Updates doxygen errors in documentation for code in the drivers/ directory.
1 parent cd7abc0 commit b3ce996

31 files changed

+117
-60
lines changed

‎drivers/AnalogIn.h

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace mbed {
3030

3131
/** An analog input, used for reading the voltage on a pin
3232
*
33-
* @Note Synchronization level: Thread safe
33+
* @note Synchronization level: Thread safe
3434
*
3535
* Example:
3636
* @code
@@ -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();

‎drivers/AnalogOut.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** An analog output, used for setting the voltage on a pin
3131
*
32-
* @Note Synchronization level: Thread safe
32+
* @note Synchronization level: Thread safe
3333
*
3434
* Example:
3535
* @code
@@ -55,7 +55,7 @@ class AnalogOut {
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);

‎drivers/BusIn.h

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ namespace mbed {
2626

2727
/** A digital input bus, used for reading the state of a collection of pins
2828
*
29-
* @Note Synchronization level: Thread safe
29+
* @note Synchronization level: Thread safe
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

‎drivers/BusInOut.h

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,30 @@ namespace mbed {
2525

2626
/** A digital input output bus, used for setting the state of a collection of pins
2727
*
28-
* @Note Synchronization level: Thread safe
28+
* @note Synchronization level: Thread safe
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

‎drivers/BusOut.h

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,24 @@ class BusOut {
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();

‎drivers/CAN.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ namespace mbed {
3030

3131
/** CANMessage class
3232
*
33-
* @Note Synchronization level: Thread safe
33+
* @note Synchronization level: Thread safe
3434
*/
3535
class CANMessage : public CAN_Message {
3636

@@ -213,7 +213,7 @@ class CAN {
213213
* generated.
214214
*
215215
* @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)
216+
* @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)
217217
*/
218218
void attach(Callback<void()> func, IrqType type=RxIrq);
219219

@@ -222,7 +222,7 @@ class CAN {
222222
*
223223
* @param obj pointer to the object to call the member function on
224224
* @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)
225+
* @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)
226226
*/
227227
template<typename T>
228228
void attach(T* obj, void (T::*method)(), IrqType type=RxIrq) {
@@ -235,7 +235,7 @@ class CAN {
235235
*
236236
* @param obj pointer to the object to call the member function on
237237
* @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)
238+
* @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)
239239
*/
240240
template<typename T>
241241
void attach(T* obj, void (*method)(T*), IrqType type=RxIrq) {

‎drivers/DigitalIn.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace mbed {
2727

2828
/** A digital input, used for reading the state of a pin
2929
*
30-
* @Note Synchronization level: Interrupt safe
30+
* @note Synchronization level: Interrupt safe
3131
*
3232
* Example:
3333
* @code
@@ -82,7 +82,7 @@ class DigitalIn {
8282

8383
/** Set the input pin mode
8484
*
85-
* @param mode PullUp, PullDown, PullNone, OpenDrain
85+
* @param pull PullUp, PullDown, PullNone, OpenDrain
8686
*/
8787
void mode(PinMode pull) {
8888
core_util_critical_section_enter();

‎drivers/DigitalInOut.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ namespace mbed {
2727

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

@@ -92,7 +92,7 @@ class DigitalInOut {
9292

9393
/** Set the input pin mode
9494
*
95-
* @param mode PullUp, PullDown, PullNone, OpenDrain
95+
* @param pull PullUp, PullDown, PullNone, OpenDrain
9696
*/
9797
void mode(PinMode pull) {
9898
core_util_critical_section_enter();

‎drivers/DigitalOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ namespace mbed {
2626

2727
/** A digital output, used for setting the state of a pin
2828
*
29-
* @Note Synchronization level: Interrupt safe
29+
* @note Synchronization level: Interrupt safe
3030
*
3131
* Example:
3232
* @code

‎drivers/Ethernet.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ namespace mbed {
2626

2727
/** An ethernet interface, to use with the ethernet pins.
2828
*
29-
* @Note Synchronization level: Not protected
29+
* @note Synchronization level: Not protected
3030
*
3131
* Example:
3232
* @code

‎drivers/FlashIAP.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ namespace mbed {
3535

3636
/** Flash IAP driver. It invokes flash HAL functions.
3737
*
38-
* Note Synchronization level: Thread safe
38+
* @note Synchronization level: Thread safe
3939
*/
4040
class FlashIAP {
4141
public:

‎drivers/I2C.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ namespace mbed {
3636

3737
/** An I2C Master, used for communicating with I2C slave devices
3838
*
39-
* @Note Synchronization level: Thread safe
39+
* @note Synchronization level: Thread safe
4040
*
4141
* Example:
4242
* @code

‎drivers/I2CSlave.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace mbed {
2828

2929
/** An I2C Slave, used for communicating with an I2C Master device
3030
*
31-
* @Note Synchronization level: Not protected
31+
* @note Synchronization level: Not protected
3232
*
3333
* Example:
3434
* @code
@@ -127,7 +127,7 @@ class I2CSlave {
127127

128128
/** Write a single byte to an I2C master.
129129
*
130-
* @data the byte to write
130+
* @param data the byte to write
131131
*
132132
* @returns
133133
* '1' if an ACK was received,

‎drivers/InterruptIn.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace mbed {
3232

3333
/** A digital interrupt input, used to call a function on a rising or falling edge
3434
*
35-
* @Note Synchronization level: Interrupt safe
35+
* @note Synchronization level: Interrupt safe
3636
*
3737
* Example:
3838
* @code
@@ -63,7 +63,6 @@ class InterruptIn {
6363
/** Create an InterruptIn connected to the specified pin
6464
*
6565
* @param pin InterruptIn pin to connect to
66-
* @param name (optional) A string to identify the object
6766
*/
6867
InterruptIn(PinName pin);
6968
virtual ~InterruptIn();
@@ -131,7 +130,7 @@ class InterruptIn {
131130

132131
/** Set the input pin mode
133132
*
134-
* @param mode PullUp, PullDown, PullNone
133+
* @param pull PullUp, PullDown, PullNone
135134
*/
136135
void mode(PinMode pull);
137136

‎drivers/InterruptManager.h

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

2828
/** Use this singleton if you need to chain interrupt handlers.
2929
*
30-
* @Note Synchronization level: Thread safe
30+
* @note Synchronization level: Thread safe
3131
*
3232
* Example (for LPC1768):
3333
* @code

‎drivers/LowPowerTicker.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** Low Power Ticker
3131
*
32-
* @Note Synchronization level: Interrupt safe
32+
* @note Synchronization level: Interrupt safe
3333
*/
3434
class LowPowerTicker : public Ticker {
3535

‎drivers/LowPowerTimeout.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** Low Power Timout
3131
*
32-
* @Note Synchronization level: Interrupt safe
32+
* @note Synchronization level: Interrupt safe
3333
*/
3434
class LowPowerTimeout : public LowPowerTicker {
3535

‎drivers/LowPowerTimer.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** Low power timer
3131
*
32-
* @Note Synchronization level: Interrupt safe
32+
* @note Synchronization level: Interrupt safe
3333
*/
3434
class LowPowerTimer : public Timer {
3535

‎drivers/PortIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** A multiple pin digital input
3131
*
32-
* @Note Synchronization level: Interrupt safe
32+
* @note Synchronization level: Interrupt safe
3333
*
3434
* Example:
3535
* @code

‎drivers/PortInOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ namespace mbed {
2929

3030
/** A multiple pin digital in/out used to set/read multiple bi-directional pins
3131
*
32-
* @Note Synchronization level: Interrupt safe
32+
* @note Synchronization level: Interrupt safe
3333
*/
3434
class PortInOut {
3535
public:

‎drivers/PortOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ namespace mbed {
2828
/** @{*/
2929
/** A multiple pin digital out
3030
*
31-
* @Note Synchronization level: Interrupt safe
31+
* @note Synchronization level: Interrupt safe
3232
*
3333
* Example:
3434
* @code

0 commit comments

Comments
 (0)