ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updates doxygen errors in documentation for code in the drivers/ directory.

pull/4111/head
Sam Grove 2017-04-04 12:40:09 -05:00
parent cd7abc019f
commit b3ce99676b
31 changed files with 117 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
drivers/AnalogIn.h
View File

@ -30,7 +30,7 @@ namespace mbed {
/** An analog input, used for reading the voltage on a pin
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example:
* @code
@ -56,7 +56,6 @@ public:
/** Create an AnalogIn, connected to the specified pin
*
* @param pin AnalogIn pin to connect to
* @param name (optional) A string to identify the object
*/
AnalogIn(PinName pin) {
lock();

4
drivers/AnalogOut.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** An analog output, used for setting the voltage on a pin
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example:
* @code
@ -55,7 +55,7 @@ public:
/** Create an AnalogOut connected to the specified pin
*
* @param AnalogOut pin to connect to (18)
* @param pin AnalogOut pin to connect to
*/
AnalogOut(PinName pin) {
analogout_init(&_dac, pin);

28
drivers/BusIn.h
View File

@ -26,7 +26,7 @@ namespace mbed {
/** A digital input bus, used for reading the state of a collection of pins
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*/
class BusIn {
@ -35,7 +35,22 @@ public:
/** Create an BusIn, connected to the specified pins
*
* @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
* @param p0 DigitalIn pin to connect to bus bit
* @param p1 DigitalIn pin to connect to bus bit
* @param p2 DigitalIn pin to connect to bus bit
* @param p3 DigitalIn pin to connect to bus bit
* @param p4 DigitalIn pin to connect to bus bit
* @param p5 DigitalIn pin to connect to bus bit
* @param p6 DigitalIn pin to connect to bus bit
* @param p7 DigitalIn pin to connect to bus bit
* @param p8 DigitalIn pin to connect to bus bit
* @param p9 DigitalIn pin to connect to bus bit
* @param p10 DigitalIn pin to connect to bus bit
* @param p11 DigitalIn pin to connect to bus bit
* @param p12 DigitalIn pin to connect to bus bit
* @param p13 DigitalIn pin to connect to bus bit
* @param p14 DigitalIn pin to connect to bus bit
* @param p15 DigitalIn pin to connect to bus bit
*
* @note
* It is only required to specify as many pin variables as is required
@ -46,7 +61,12 @@ public:
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
BusIn(PinName pins[16]);
/** Create an BusIn, connected to the specified pins
*
* @param pins An array of pins to connect to bus bit
*/
BusIn(PinName pins[16]);
virtual ~BusIn();
@ -59,7 +79,7 @@ public:
/** Set the input pin mode
*
* @param mode PullUp, PullDown, PullNone
* @param pull PullUp, PullDown, PullNone
*/
void mode(PinMode pull);

25
drivers/BusInOut.h
View File

@ -25,7 +25,7 @@ namespace mbed {
/** A digital input output bus, used for setting the state of a collection of pins
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*/
class BusInOut {
@ -33,7 +33,22 @@ public:
/** Create an BusInOut, connected to the specified pins
*
* @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
* @param p0 DigitalInOut pin to connect to bus bit
* @param p1 DigitalInOut pin to connect to bus bit
* @param p2 DigitalInOut pin to connect to bus bit
* @param p3 DigitalInOut pin to connect to bus bit
* @param p4 DigitalInOut pin to connect to bus bit
* @param p5 DigitalInOut pin to connect to bus bit
* @param p6 DigitalInOut pin to connect to bus bit
* @param p7 DigitalInOut pin to connect to bus bit
* @param p8 DigitalInOut pin to connect to bus bit
* @param p9 DigitalInOut pin to connect to bus bit
* @param p10 DigitalInOut pin to connect to bus bit
* @param p11 DigitalInOut pin to connect to bus bit
* @param p12 DigitalInOut pin to connect to bus bit
* @param p13 DigitalInOut pin to connect to bus bit
* @param p14 DigitalInOut pin to connect to bus bit
* @param p15 DigitalInOut pin to connect to bus bit
*
* @note
* It is only required to specify as many pin variables as is required
@ -44,6 +59,10 @@ public:
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
/** Create an BusInOut, connected to the specified pins
*
* @param pins An array of pins to construct a BusInOut from
*/
BusInOut(PinName pins[16]);
virtual ~BusInOut();
@ -73,7 +92,7 @@ public:
/** Set the input pin mode
*
* @param mode PullUp, PullDown, PullNone
* @param pull PullUp, PullDown, PullNone
*/
void mode(PinMode pull);

23
drivers/BusOut.h
View File

@ -31,9 +31,24 @@ public:
/** Create an BusOut, connected to the specified pins
*
* @param p<n> DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
* @param p0 DigitalOut pin to connect to bus bit
* @param p1 DigitalOut pin to connect to bus bit
* @param p2 DigitalOut pin to connect to bus bit
* @param p3 DigitalOut pin to connect to bus bit
* @param p4 DigitalOut pin to connect to bus bit
* @param p5 DigitalOut pin to connect to bus bit
* @param p6 DigitalOut pin to connect to bus bit
* @param p7 DigitalOut pin to connect to bus bit
* @param p8 DigitalOut pin to connect to bus bit
* @param p9 DigitalOut pin to connect to bus bit
* @param p10 DigitalOut pin to connect to bus bit
* @param p11 DigitalOut pin to connect to bus bit
* @param p12 DigitalOut pin to connect to bus bit
* @param p13 DigitalOut pin to connect to bus bit
* @param p14 DigitalOut pin to connect to bus bit
* @param p15 DigitalOut pin to connect to bus bit
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* @note
* It is only required to specify as many pin variables as is required
@ -44,6 +59,10 @@ public:
PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
/** Create an BusOut, connected to the specified pins
*
* @param pins An array of pins to connect to bus the bit
*/
BusOut(PinName pins[16]);
virtual ~BusOut();

8
drivers/CAN.h
View File

@ -30,7 +30,7 @@ namespace mbed {
/** CANMessage class
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*/
class CANMessage : public CAN_Message {
@ -213,7 +213,7 @@ public:
* generated.
*
* @param func A pointer to a void function, or 0 to set as none
* @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)
* @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)
*/
void attach(Callback<void()> func, IrqType type=RxIrq);
@ -222,7 +222,7 @@ public:
*
* @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called
* @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)
* @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)
*/
template<typename T>
void attach(T* obj, void (T::*method)(), IrqType type=RxIrq) {
@ -235,7 +235,7 @@ public:
*
* @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called
* @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)
* @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)
*/
template<typename T>
void attach(T* obj, void (*method)(T*), IrqType type=RxIrq) {

4
drivers/DigitalIn.h
View File

@ -27,7 +27,7 @@ namespace mbed {
/** A digital input, used for reading the state of a pin
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code
@ -82,7 +82,7 @@ public:
/** Set the input pin mode
*
* @param mode PullUp, PullDown, PullNone, OpenDrain
* @param pull PullUp, PullDown, PullNone, OpenDrain
*/
void mode(PinMode pull) {
core_util_critical_section_enter();

4
drivers/DigitalInOut.h
View File

@ -27,7 +27,7 @@ namespace mbed {
/** A digital input/output, used for setting or reading a bi-directional pin
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class DigitalInOut {
@ -92,7 +92,7 @@ public:
/** Set the input pin mode
*
* @param mode PullUp, PullDown, PullNone, OpenDrain
* @param pull PullUp, PullDown, PullNone, OpenDrain
*/
void mode(PinMode pull) {
core_util_critical_section_enter();

2
drivers/DigitalOut.h
View File

@ -26,7 +26,7 @@ namespace mbed {
/** A digital output, used for setting the state of a pin
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code

2
drivers/Ethernet.h
View File

@ -26,7 +26,7 @@ namespace mbed {
/** An ethernet interface, to use with the ethernet pins.
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
*
* Example:
* @code

2
drivers/FlashIAP.h
View File

@ -35,7 +35,7 @@ namespace mbed {
/** Flash IAP driver. It invokes flash HAL functions.
*
* Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*/
class FlashIAP {
public:

2
drivers/I2C.h
View File

@ -36,7 +36,7 @@ namespace mbed {
/** An I2C Master, used for communicating with I2C slave devices
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example:
* @code

4
drivers/I2CSlave.h
View File

@ -28,7 +28,7 @@ namespace mbed {
/** An I2C Slave, used for communicating with an I2C Master device
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
*
* Example:
* @code
@ -127,7 +127,7 @@ public:
/** Write a single byte to an I2C master.
*
* @data the byte to write
* @param data the byte to write
*
* @returns
* '1' if an ACK was received,

5
drivers/InterruptIn.h
View File

@ -32,7 +32,7 @@ namespace mbed {
/** A digital interrupt input, used to call a function on a rising or falling edge
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code
@ -63,7 +63,6 @@ public:
/** Create an InterruptIn connected to the specified pin
*
* @param pin InterruptIn pin to connect to
* @param name (optional) A string to identify the object
*/
InterruptIn(PinName pin);
virtual ~InterruptIn();
@ -131,7 +130,7 @@ public:
/** Set the input pin mode
*
* @param mode PullUp, PullDown, PullNone
* @param pull PullUp, PullDown, PullNone
*/
void mode(PinMode pull);

2
drivers/InterruptManager.h
View File

@ -27,7 +27,7 @@ namespace mbed {
/** Use this singleton if you need to chain interrupt handlers.
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example (for LPC1768):
* @code

2
drivers/LowPowerTicker.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** Low Power Ticker
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class LowPowerTicker : public Ticker {

2
drivers/LowPowerTimeout.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** Low Power Timout
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class LowPowerTimeout : public LowPowerTicker {

2
drivers/LowPowerTimer.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** Low power timer
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class LowPowerTimer : public Timer {

2
drivers/PortIn.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** A multiple pin digital input
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code

2
drivers/PortInOut.h
View File

@ -29,7 +29,7 @@ namespace mbed {
/** A multiple pin digital in/out used to set/read multiple bi-directional pins
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class PortInOut {
public:

2
drivers/PortOut.h
View File

@ -28,7 +28,7 @@ namespace mbed {
/** @{*/
/** A multiple pin digital out
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code

19
drivers/PwmOut.h
View File

@ -28,7 +28,7 @@ namespace mbed {
/** A pulse-width modulation digital output
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example
* @code
@ -47,13 +47,6 @@ namespace mbed {
* }
* }
* @endcode
*
* @note
* On the LPC1768 and LPC2368, the PWMs all share the same
* period - if you change the period for one, you change it for all.
* Although routines that change the period maintain the duty cycle
* for its PWM, all other PWMs will require their duty cycle to be
* refreshed.
*/
class PwmOut {
@ -90,7 +83,7 @@ public:
* 0.0f (representing on 0%) and 1.0f (representing on 100%).
*
* @note
* This value may not match exactly the value set by a previous <write>.
* This value may not match exactly the value set by a previous write().
*/
float read() {
core_util_critical_section_enter();
@ -101,6 +94,7 @@ public:
/** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
*
* @param seconds Change the period of a PWM signal in seconds (float) without modifying the duty cycle
* @note
* The resolution is currently in microseconds; periods smaller than this
* will be set to zero.
@ -112,6 +106,7 @@ public:
}
/** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
* @param ms Change the period of a PWM signal in milli-seconds without modifying the duty cycle
*/
void period_ms(int ms) {
core_util_critical_section_enter();
@ -120,6 +115,7 @@ public:
}
/** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
* @param us Change the period of a PWM signal in micro-seconds without modifying the duty cycle
*/
void period_us(int us) {
core_util_critical_section_enter();
@ -128,6 +124,7 @@ public:
}
/** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
* @param seconds Change the pulse width of a PWM signal specified in seconds (float)
*/
void pulsewidth(float seconds) {
core_util_critical_section_enter();
@ -136,6 +133,7 @@ public:
}
/** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
* @param ms Change the pulse width of a PWM signal specified in milli-seconds
*/
void pulsewidth_ms(int ms) {
core_util_critical_section_enter();
@ -144,6 +142,7 @@ public:
}
/** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
* @param us Change the pulse width of a PWM signal specified in micro-seconds
*/
void pulsewidth_us(int us) {
core_util_critical_section_enter();
@ -159,6 +158,8 @@ public:
return *this;
}
/** A operator shorthand for write()
*/
PwmOut& operator= (PwmOut& rhs) {
// Underlying call is thread safe
write(rhs.read());

2
drivers/RawSerial.h
View File

@ -34,7 +34,7 @@ namespace mbed {
* Can be used for Full Duplex communication, or Simplex by specifying
* one pin as NC (Not Connected)
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
*
* Example:
* @code

4
drivers/SPI.h
View File

@ -41,9 +41,9 @@ namespace mbed {
* The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
*
* Most SPI devices will also require Chip Select and Reset signals. These
* can be controlled using <DigitalOut> pins
* can be controlled using DigitalOut pins
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example:
* @code

2
drivers/SPISlave.h
View File

@ -30,7 +30,7 @@ namespace mbed {
*
* The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
*
* @Note Synchronization level: Not protected
* @note Synchronization level: Not protected
*
* Example:
* @code

2
drivers/Serial.h
View File

@ -34,7 +34,7 @@ namespace mbed {
* Can be used for Full Duplex communication, or Simplex by specifying
* one pin as NC (Not Connected)
*
* @Note Synchronization level: Thread safe
* @note Synchronization level: Thread safe
*
* Example:
* @code

4
drivers/SerialBase.h
View File

@ -37,7 +37,7 @@ namespace mbed {
/** A base class for serial port implementations
* Can't be instantiated directly (use Serial or RawSerial)
*
* @Note Synchronization level: Set by subclass
* @note Synchronization level: Set by subclass
*/
class SerialBase {
@ -74,7 +74,7 @@ public:
*
* @param bits The number of bits in a word (5-8; default = 8)
* @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
* @param stop The number of stop bits (1 or 2; default = 1)
* @param stop_bits The number of stop bits (1 or 2; default = 1)
*/
void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);

8
drivers/Ticker.h
View File

@ -28,7 +28,7 @@ namespace mbed {
*
* You can use as many seperate Ticker objects as you require.
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code
@ -97,7 +97,7 @@ public:
/** Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
*
* @param fptr pointer to the function to be called
* @param func pointer to the function to be called
* @param t the time between calls in micro-seconds
*/
void attach_us(Callback<void()> func, timestamp_t t) {
@ -107,8 +107,8 @@ public:
/** Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
*
* @param tptr pointer to the object to call the member function on
* @param mptr pointer to the member function to be called
* @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called
* @param t the time between calls in micro-seconds
* @deprecated
* The attach_us function does not support cv-qualifiers. Replaced by

2
drivers/Timeout.h
View File

@ -26,7 +26,7 @@ namespace mbed {
*
* You can use as many seperate Timeout objects as you require.
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code

2
drivers/Timer.h
View File

@ -25,7 +25,7 @@ namespace mbed {
/** A general purpose timer
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*
* Example:
* @code

2
drivers/TimerEvent.h
View File

@ -25,7 +25,7 @@ namespace mbed {
/** Base abstraction for timer interrupts
*
* @Note Synchronization level: Interrupt safe
* @note Synchronization level: Interrupt safe
*/
class TimerEvent {
public: