Skip to content

Drivers: fix typos in doxygen #8564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion drivers/AnalogIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class AnalogIn {
/** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
*
* @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()
{
Expand Down
2 changes: 1 addition & 1 deletion drivers/AnalogOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class AnalogOut {
/** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
*
* @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)
{
Expand Down
2 changes: 1 addition & 1 deletion drivers/CAN.h
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ class CAN : private NonCopyable<CAN> {
*/
int mode(Mode mode);

/** Filter out incomming messages
/** Filter out incoming messages
*
* @param id the id to filter on
* @param mask the mask applied to the id
Expand Down
2 changes: 1 addition & 1 deletion drivers/Ethernet.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class Ethernet : private NonCopyable<Ethernet> {

public:

/** Initialise the ethernet interface.
/** Initialize the ethernet interface.
*/
Ethernet();

Expand Down
2 changes: 1 addition & 1 deletion drivers/I2C.h
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ class I2C : private NonCopyable<I2C> {
* This function locks the deep sleep until any event has occurred
*
* @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 rx_buffer The RX buffer, which is used for received data
* @param rx_length The length of RX buffer in bytes
Expand Down
2 changes: 1 addition & 1 deletion drivers/InterruptIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ class InterruptIn : private NonCopyable<InterruptIn> {
*/
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().
*/
void disable_irq();
Expand Down
2 changes: 1 addition & 1 deletion drivers/MbedCRC.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ class MbedCRC {
* MbedCRC <POLY_7BIT_SD, 7> ct; --- Valid POLY_7BIT_SD
* MbedCRC <0x1021, 16> ct; --- Valid POLY_16BIT_CCITT
* 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
* polynomials with different intial/final/reflect values
*
Expand Down
2 changes: 1 addition & 1 deletion drivers/PwmOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class PwmOut {
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,
* specified as a percentage. The value should lie between
Expand Down
8 changes: 4 additions & 4 deletions drivers/SPI.h
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ class SPI : private NonCopyable<SPI> {
*
* 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.
* @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,
Expand Down Expand Up @@ -215,7 +215,7 @@ class SPI : private NonCopyable<SPI> {

/** 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
* @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,
Expand All @@ -233,7 +233,7 @@ class SPI : private NonCopyable<SPI> {

/** 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.
* @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,
Expand All @@ -251,7 +251,7 @@ class SPI : private NonCopyable<SPI> {

/** 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.
* @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,
Expand Down
14 changes: 7 additions & 7 deletions drivers/SerialBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ class SerialBase : private NonCopyable<SerialBase> {
/** 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 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);

/** Attach a member function to call whenever a serial interrupt is generated
*
* @param obj pointer to the object to call the member function on
* @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
* The attach function does not support cv-qualifiers. Replaced by
* attach(callback(obj, method), type).
Expand All @@ -123,7 +123,7 @@ class SerialBase : private NonCopyable<SerialBase> {
*
* @param obj pointer to the object to call the member function on
* @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
* The attach function does not support cv-qualifiers. Replaced by
* attach(callback(obj, method), type).
Expand Down Expand Up @@ -167,7 +167,7 @@ class SerialBase : private NonCopyable<SerialBase> {

#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
*
Expand All @@ -178,7 +178,7 @@ class SerialBase : private NonCopyable<SerialBase> {
*/
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
*
Expand All @@ -193,7 +193,7 @@ class SerialBase : private NonCopyable<SerialBase> {
*/
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
*
Expand All @@ -205,7 +205,7 @@ class SerialBase : private NonCopyable<SerialBase> {
*/
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
*
Expand Down