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

Merge pull request #8564 from kegilbert/driver-doxy-typo-fix 

Drivers: fix typos in doxygen
pull/8603/head
Martin Kojtal 2018-10-31 11:39:04 +01:00 committed by GitHub
parent fba0669194 e8e9076662
commit 8976709c9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/AnalogIn.h
View File

@ -79,7 +79,7 @@ public:
/** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF] /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
* *
* @returns * @returns
* 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value * 16-bit unsigned short representing the current input voltage, normalized to a 16-bit value
*/ */
unsigned short read_u16() unsigned short read_u16()
{ {

2
drivers/AnalogOut.h
View File

@ -79,7 +79,7 @@ public:
/** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF] /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
* *
* @param value 16-bit unsigned short representing the output voltage, * @param value 16-bit unsigned short representing the output voltage,
* normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v) * normalized to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
*/ */
void write_u16(unsigned short value) void write_u16(unsigned short value)
{ {

2
drivers/CAN.h
View File

@ -201,7 +201,7 @@ public:
*/ */
int mode(Mode mode); int mode(Mode mode);
/** Filter out incomming messages /** Filter out incoming messages
* *
* @param id the id to filter on * @param id the id to filter on
* @param mask the mask applied to the id * @param mask the mask applied to the id

2
drivers/Ethernet.h
View File

@ -59,7 +59,7 @@ class Ethernet : private NonCopyable<Ethernet> {
public: public:
/** Initialise the ethernet interface. /** Initialize the ethernet interface.
*/ */
Ethernet(); Ethernet();

2
drivers/I2C.h
View File

@ -181,7 +181,7 @@ public:
* This function locks the deep sleep until any event has occurred * This function locks the deep sleep until any event has occurred
* *
* @param address 8/10 bit I2C slave address * @param address 8/10 bit I2C slave address
* @param tx_buffer The TX buffer with data to be transfered * @param tx_buffer The TX buffer with data to be transferred
* @param tx_length The length of TX buffer in bytes * @param tx_length The length of TX buffer in bytes
* @param rx_buffer The RX buffer, which is used for received data * @param rx_buffer The RX buffer, which is used for received data
* @param rx_length The length of RX buffer in bytes * @param rx_length The length of RX buffer in bytes

2
drivers/InterruptIn.h
View File

@ -156,7 +156,7 @@ public:
*/ */
void enable_irq(); void enable_irq();
/** Disable IRQ. This method depends on hw implementation, might disable one /** Disable IRQ. This method depends on hardware implementation, might disable one
* port interrupts. For further information, check gpio_irq_disable(). * port interrupts. For further information, check gpio_irq_disable().
*/ */
void disable_irq(); void disable_irq();

2
drivers/MbedCRC.h
View File

@ -119,7 +119,7 @@ public:
* MbedCRC <POLY_7BIT_SD, 7> ct; --- Valid POLY_7BIT_SD * MbedCRC <POLY_7BIT_SD, 7> ct; --- Valid POLY_7BIT_SD
* MbedCRC <0x1021, 16> ct; --- Valid POLY_16BIT_CCITT * MbedCRC <0x1021, 16> ct; --- Valid POLY_16BIT_CCITT
* MbedCRC <POLY_16BIT_CCITT, 32> ct; --- Invalid, compilation error * MbedCRC <POLY_16BIT_CCITT, 32> ct; --- Invalid, compilation error
* MbedCRC <POLY_16BIT_CCITT, 32> ct (i,f,rd,rr) Consturctor can be used for not supported polynomials * MbedCRC <POLY_16BIT_CCITT, 32> ct (i,f,rd,rr) Constructor can be used for not supported polynomials
* MbedCRC<POLY_16BIT_CCITT, 16> sd(0, 0, false, false); Constructor can also be used for supported * MbedCRC<POLY_16BIT_CCITT, 16> sd(0, 0, false, false); Constructor can also be used for supported
* polynomials with different intial/final/reflect values * polynomials with different intial/final/reflect values
* *

2
drivers/PwmOut.h
View File

@ -71,7 +71,7 @@ public:
core_util_critical_section_exit(); core_util_critical_section_exit();
} }
/** Set the ouput duty-cycle, specified as a percentage (float) /** Set the output duty-cycle, specified as a percentage (float)
* *
* @param value A floating-point value representing the output duty-cycle, * @param value A floating-point value representing the output duty-cycle,
* specified as a percentage. The value should lie between * specified as a percentage. The value should lie between

8
drivers/SPI.h
View File

@ -163,7 +163,7 @@ public:
* *
* This function locks the deep sleep until any event has occurred. * This function locks the deep sleep until any event has occurred.
* *
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
* the default SPI value is sent. * the default SPI value is sent.
* @param tx_length The length of TX buffer in bytes. * @param tx_length The length of TX buffer in bytes.
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed, * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@ -215,7 +215,7 @@ protected:
/** Start the transfer or put it on the queue. /** Start the transfer or put it on the queue.
* *
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
* the default SPI value is sent * the default SPI value is sent
* @param tx_length The length of TX buffer in bytes. * @param tx_length The length of TX buffer in bytes.
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed, * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@ -233,7 +233,7 @@ protected:
/** Put a transfer on the transfer queue. /** Put a transfer on the transfer queue.
* *
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
* the default SPI value is sent. * the default SPI value is sent.
* @param tx_length The length of TX buffer in bytes. * @param tx_length The length of TX buffer in bytes.
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed, * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@ -251,7 +251,7 @@ protected:
/** Configure a callback, SPI peripheral, and initiate a new transfer. /** Configure a callback, SPI peripheral, and initiate a new transfer.
* *
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
* the default SPI value is sent. * the default SPI value is sent.
* @param tx_length The length of TX buffer in bytes. * @param tx_length The length of TX buffer in bytes.
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed, * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,

14
drivers/SerialBase.h
View File

@ -97,7 +97,7 @@ public:
/** Attach a function to call whenever a serial interrupt is generated /** Attach a function to call whenever a serial interrupt is generated
* *
* @param func A pointer to a void function, or 0 to set as none * @param func A pointer to a void function, or 0 to set as none
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
*/ */
void attach(Callback<void()> func, IrqType type = RxIrq); void attach(Callback<void()> func, IrqType type = RxIrq);
@ -105,7 +105,7 @@ public:
* *
* @param obj pointer to the object to call the member function on * @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called * @param method pointer to the member function to be called
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
* @deprecated * @deprecated
* The attach function does not support cv-qualifiers. Replaced by * The attach function does not support cv-qualifiers. Replaced by
* attach(callback(obj, method), type). * attach(callback(obj, method), type).
@ -123,7 +123,7 @@ public:
* *
* @param obj pointer to the object to call the member function on * @param obj pointer to the object to call the member function on
* @param method pointer to the member function to be called * @param method pointer to the member function to be called
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty) * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
* @deprecated * @deprecated
* The attach function does not support cv-qualifiers. Replaced by * The attach function does not support cv-qualifiers. Replaced by
* attach(callback(obj, method), type). * attach(callback(obj, method), type).
@ -167,7 +167,7 @@ public:
#if DEVICE_SERIAL_ASYNCH #if DEVICE_SERIAL_ASYNCH
/** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback /** Begin asynchronous write using 8bit buffer. The completion invokes registered TX event callback
* *
* This function locks the deep sleep until any event has occurred * This function locks the deep sleep until any event has occurred
* *
@ -178,7 +178,7 @@ public:
*/ */
int write(const uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE); int write(const uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE);
/** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback /** Begin asynchronous write using 16bit buffer. The completion invokes registered TX event callback
* *
* This function locks the deep sleep until any event has occurred * This function locks the deep sleep until any event has occurred
* *
@ -193,7 +193,7 @@ public:
*/ */
void abort_write(); void abort_write();
/** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback. /** Begin asynchronous reading using 8bit buffer. The completion invokes registered RX event callback.
* *
* This function locks the deep sleep until any event has occurred * This function locks the deep sleep until any event has occurred
* *
@ -205,7 +205,7 @@ public:
*/ */
int read(uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH); int read(uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
/** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback. /** Begin asynchronous reading using 16bit buffer. The completion invokes registered RX event callback.
* *
* This function locks the deep sleep until any event has occurred * This function locks the deep sleep until any event has occurred
* *