Skip to content

Commit 8e84d9a

Browse files
committed
Fix Doxygen spelling
1 parent e36719e commit 8e84d9a

File tree

6 files changed

+9
-8
lines changed

6 files changed

+9
-8
lines changed

drivers/USBKeyboard.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ class USBKeyboard: public USBHID, public mbed::Stream {
189189
virtual void report_rx();
190190

191191
/**
192-
* Read status of lock keys. Useful to switch-on/off leds according to key pressed. Only the first three bits of the result is important:
192+
* Read status of lock keys. Useful to switch-on/off LEDs according to key pressed. Only the first three bits of the result is important:
193193
* - First bit: NUM_LOCK
194194
* - Second bit: CAPS_LOCK
195195
* - Third bit: SCROLL_LOCK

drivers/USBMSD.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
*
4343
* Introduction
4444
*
45-
* USBMSD implements the MSD protocol. It permits to access a block device (flash, sdcard,...)
45+
* USBMSD implements the MSD protocol. It permits to access a block device (flash, SD Card,...)
4646
* from a computer over USB.
4747
*
4848
* @code

drivers/USBMouseKeyboard.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ class USBMouseKeyboard: public USBHID, public mbed::Stream {
215215
bool media_control(MEDIA_KEY key);
216216

217217
/**
218-
* Read status of lock keys. Useful to switch-on/off leds according to key pressed. Only the first three bits of the result is important:
218+
* Read status of lock keys. Useful to switch-on/off LEDs according to key pressed. Only the first three bits of the result is important:
219219
* - First bit: NUM_LOCK
220220
* - Second bit: CAPS_LOCK
221221
* - Third bit: SCROLL_LOCK

drivers/internal/USBDevice.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,13 +184,13 @@ class USBDevice: public USBPhyEvents {
184184
void endpoint_stall(usb_ep_t endpoint);
185185

186186
/**
187-
* Unstall an endpoint
187+
* Un-stall an endpoint
188188
*
189-
* Unstalling an endpoint resets data toggle back to DATA0.
189+
* Un-stalling an endpoint resets data toggle back to DATA0.
190190
* Additionally, if there is an ongoing transfer on this endpoint
191191
* it will be aborted.
192192
*
193-
* @param endpoint Endpoint to unstall
193+
* @param endpoint Endpoint to un-stall
194194
* @note This endpoint must already have been setup with endpoint_add
195195
*/
196196
void endpoint_unstall(usb_ep_t endpoint);

hal/usb/USBPhy.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ class USBPhy {
259259
virtual void endpoint_stall(usb_ep_t endpoint) = 0;
260260

261261
/**
262-
* Unstall the endpoint
262+
* Un-stall the endpoint
263263
*
264264
* Clear the HALT feature on this endpoint so communication can
265265
* resume.

tools/test/travis-ci/doxy-spellchecker/ignore.en.pws

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,5 @@ TCPSocket
9696
UDPSocket
9797
Socket
9898
unregister
99-
_doxy_
99+
deinit
100+
_doxy_

0 commit comments

Comments
 (0)