Skip to content

Commit e8e9076

Browse files
committed
Fix typos in Drivers doxygen
1 parent 1bbcfff commit e8e9076

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

drivers/AnalogIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class AnalogIn {
7979
/** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
8080
*
8181
* @returns
82-
* 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
82+
* 16-bit unsigned short representing the current input voltage, normalized to a 16-bit value
8383
*/
8484
unsigned short read_u16()
8585
{

drivers/AnalogOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ class AnalogOut {
7979
/** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
8080
*
8181
* @param value 16-bit unsigned short representing the output voltage,
82-
* normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
82+
* normalized to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
8383
*/
8484
void write_u16(unsigned short value)
8585
{

drivers/CAN.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ class CAN : private NonCopyable<CAN> {
201201
*/
202202
int mode(Mode mode);
203203

204-
/** Filter out incomming messages
204+
/** Filter out incoming messages
205205
*
206206
* @param id the id to filter on
207207
* @param mask the mask applied to the id

drivers/Ethernet.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class Ethernet : private NonCopyable<Ethernet> {
5959

6060
public:
6161

62-
/** Initialise the ethernet interface.
62+
/** Initialize the ethernet interface.
6363
*/
6464
Ethernet();
6565

drivers/I2C.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ class I2C : private NonCopyable<I2C> {
181181
* This function locks the deep sleep until any event has occurred
182182
*
183183
* @param address 8/10 bit I2C slave address
184-
* @param tx_buffer The TX buffer with data to be transfered
184+
* @param tx_buffer The TX buffer with data to be transferred
185185
* @param tx_length The length of TX buffer in bytes
186186
* @param rx_buffer The RX buffer, which is used for received data
187187
* @param rx_length The length of RX buffer in bytes

drivers/InterruptIn.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ class InterruptIn : private NonCopyable<InterruptIn> {
156156
*/
157157
void enable_irq();
158158

159-
/** Disable IRQ. This method depends on hw implementation, might disable one
159+
/** Disable IRQ. This method depends on hardware implementation, might disable one
160160
* port interrupts. For further information, check gpio_irq_disable().
161161
*/
162162
void disable_irq();

drivers/MbedCRC.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ class MbedCRC {
119119
* MbedCRC <POLY_7BIT_SD, 7> ct; --- Valid POLY_7BIT_SD
120120
* MbedCRC <0x1021, 16> ct; --- Valid POLY_16BIT_CCITT
121121
* MbedCRC <POLY_16BIT_CCITT, 32> ct; --- Invalid, compilation error
122-
* MbedCRC <POLY_16BIT_CCITT, 32> ct (i,f,rd,rr) Consturctor can be used for not supported polynomials
122+
* MbedCRC <POLY_16BIT_CCITT, 32> ct (i,f,rd,rr) Constructor can be used for not supported polynomials
123123
* MbedCRC<POLY_16BIT_CCITT, 16> sd(0, 0, false, false); Constructor can also be used for supported
124124
* polynomials with different intial/final/reflect values
125125
*

drivers/PwmOut.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class PwmOut {
7171
core_util_critical_section_exit();
7272
}
7373

74-
/** Set the ouput duty-cycle, specified as a percentage (float)
74+
/** Set the output duty-cycle, specified as a percentage (float)
7575
*
7676
* @param value A floating-point value representing the output duty-cycle,
7777
* specified as a percentage. The value should lie between

drivers/SPI.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ class SPI : private NonCopyable<SPI> {
163163
*
164164
* This function locks the deep sleep until any event has occurred.
165165
*
166-
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed,
166+
* @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
167167
* the default SPI value is sent.
168168
* @param tx_length The length of TX buffer in bytes.
169169
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@@ -215,7 +215,7 @@ class SPI : private NonCopyable<SPI> {
215215

216216
/** Start the transfer or put it on the queue.
217217
*
218-
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed,
218+
* @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
219219
* the default SPI value is sent
220220
* @param tx_length The length of TX buffer in bytes.
221221
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@@ -233,7 +233,7 @@ class SPI : private NonCopyable<SPI> {
233233

234234
/** Put a transfer on the transfer queue.
235235
*
236-
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed,
236+
* @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
237237
* the default SPI value is sent.
238238
* @param tx_length The length of TX buffer in bytes.
239239
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
@@ -251,7 +251,7 @@ class SPI : private NonCopyable<SPI> {
251251

252252
/** Configure a callback, SPI peripheral, and initiate a new transfer.
253253
*
254-
* @param tx_buffer The TX buffer with data to be transfered. If NULL is passed,
254+
* @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
255255
* the default SPI value is sent.
256256
* @param tx_length The length of TX buffer in bytes.
257257
* @param rx_buffer The RX buffer which is used for received data. If NULL is passed,

drivers/SerialBase.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ class SerialBase : private NonCopyable<SerialBase> {
9797
/** Attach a function to call whenever a serial interrupt is generated
9898
*
9999
* @param func A pointer to a void function, or 0 to set as none
100-
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
100+
* @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
101101
*/
102102
void attach(Callback<void()> func, IrqType type = RxIrq);
103103

104104
/** Attach a member function to call whenever a serial interrupt is generated
105105
*
106106
* @param obj pointer to the object to call the member function on
107107
* @param method pointer to the member function to be called
108-
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
108+
* @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
109109
* @deprecated
110110
* The attach function does not support cv-qualifiers. Replaced by
111111
* attach(callback(obj, method), type).
@@ -123,7 +123,7 @@ class SerialBase : private NonCopyable<SerialBase> {
123123
*
124124
* @param obj pointer to the object to call the member function on
125125
* @param method pointer to the member function to be called
126-
* @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
126+
* @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)
127127
* @deprecated
128128
* The attach function does not support cv-qualifiers. Replaced by
129129
* attach(callback(obj, method), type).
@@ -167,7 +167,7 @@ class SerialBase : private NonCopyable<SerialBase> {
167167

168168
#if DEVICE_SERIAL_ASYNCH
169169

170-
/** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback
170+
/** Begin asynchronous write using 8bit buffer. The completion invokes registered TX event callback
171171
*
172172
* This function locks the deep sleep until any event has occurred
173173
*
@@ -178,7 +178,7 @@ class SerialBase : private NonCopyable<SerialBase> {
178178
*/
179179
int write(const uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE);
180180

181-
/** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback
181+
/** Begin asynchronous write using 16bit buffer. The completion invokes registered TX event callback
182182
*
183183
* This function locks the deep sleep until any event has occurred
184184
*
@@ -193,7 +193,7 @@ class SerialBase : private NonCopyable<SerialBase> {
193193
*/
194194
void abort_write();
195195

196-
/** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback.
196+
/** Begin asynchronous reading using 8bit buffer. The completion invokes registered RX event callback.
197197
*
198198
* This function locks the deep sleep until any event has occurred
199199
*
@@ -205,7 +205,7 @@ class SerialBase : private NonCopyable<SerialBase> {
205205
*/
206206
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);
207207

208-
/** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback.
208+
/** Begin asynchronous reading using 16bit buffer. The completion invokes registered RX event callback.
209209
*
210210
* This function locks the deep sleep until any event has occurred
211211
*

0 commit comments

Comments
 (0)