diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-16 11:01:01 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-06-16 11:01:01 +0000 |
commit | 711542ee8986482a12796ffdbc4a32912b267e44 (patch) | |
tree | ba4f65644091c31e9bcf939bb36b11771197756d /LUFA/Drivers | |
parent | 13ea700b35aa8ee9f89cf1cb06d41109d065bfcf (diff) | |
download | lufa-711542ee8986482a12796ffdbc4a32912b267e44.tar.gz lufa-711542ee8986482a12796ffdbc4a32912b267e44.tar.bz2 lufa-711542ee8986482a12796ffdbc4a32912b267e44.zip |
Spell check code and manual pages. Remove custom Doxygen CSS stylesheet, as the new 1.7 Doxygen's default stylesheet is much better.
Diffstat (limited to 'LUFA/Drivers')
-rw-r--r-- | LUFA/Drivers/Board/BENITO/Buttons.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/Board/LEDs.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/CDC.h | 6 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/MIDI.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/HIDParser.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/MIDI.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/RNDIS.c | 8 | ||||
-rw-r--r-- | LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/USB/HighLevel/Events.h | 8 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/DevChapter9.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/Host.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/HostChapter9.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/LowLevel/LowLevel.h | 4 |
16 files changed, 28 insertions, 28 deletions
diff --git a/LUFA/Drivers/Board/BENITO/Buttons.h b/LUFA/Drivers/Board/BENITO/Buttons.h index 079f4e2c1..5044d1eae 100644 --- a/LUFA/Drivers/Board/BENITO/Buttons.h +++ b/LUFA/Drivers/Board/BENITO/Buttons.h @@ -29,7 +29,7 @@ */ /** \file - * \brief Board specific Buttons driver header for the Bentio. + * \brief Board specific Buttons driver header for the Benito. * * Board specific Buttons driver header for the Benito (http://dorkbotpdx.org/wiki/benito). * @@ -40,7 +40,7 @@ /** \ingroup Group_Buttons * @defgroup Group_Buttons_BENITO BENITO * - * Board specific Buttons driver header for the Bentio (http://dorkbotpdx.org/wiki/benito). + * Board specific Buttons driver header for the Benito (http://dorkbotpdx.org/wiki/benito). * * \note This file should not be included directly. It is automatically included as needed by the Buttons driver * dispatch header located in LUFA/Drivers/Board/Buttons.h. diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index f34041e29..85eced9f1 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -58,7 +58,7 @@ * * \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If * a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect. - * If other behaviour is desired, either alias the remaining LED masks to existing LED masks via the -D + * If other behavior is desired, either alias the remaining LED masks to existing LED masks via the -D * switch in the project makefile, or alias them to nothing in the makefile to cause compilation errors when * a non-existing LED is referenced in application code. Note that this means that it is possible to make * compatible code for a board with no LEDs by making a board LED driver (see \ref Page_WritingBoardDrivers) diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h index f8f2b4325..c4e7c1285 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/ADC.h @@ -287,7 +287,7 @@ #endif } - /** Deconfigures the given ADC channel, re-enabling digital I/O mode instead of analog. This + /** De-configures the given ADC channel, re-enabling digital I/O mode instead of analog. This * function sets the associated port pin as an input and re-enabled the digital portion of * the I/O. * diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h index eb9e6aa1d..32d8c2522 100644 --- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h +++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h @@ -113,7 +113,7 @@ * \param[in] Byte Location where the read byte is to be stored * \param[in] LastByte Indicates if the byte should be ACKed if false, NAKed if true * - * \return Boolean true if the byte reception sucessfully completed, false otherwise + * \return Boolean true if the byte reception successfully completed, false otherwise */ static inline bool TWI_ReceiveByte(uint8_t* Byte, bool LastByte) { diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index 3bd9c9da3..bf08ecd39 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -54,7 +54,7 @@ * One major issue with CDC-ACM is that it requires two Interface descriptors, * which will upset most hosts when part of a multi-function "Composite" USB * device, as each interface will be loaded into a separate driver instance. To - * conbat this, you should use the "Interface Association Descriptor" addendum to + * combat this, you should use the "Interface Association Descriptor" addendum to * the USB standard which is available on most OSes when creating Composite devices. * * Another major oversight is that there is no mechanism for the host to notify the @@ -190,7 +190,7 @@ */ void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** CDC class driver event for a send break request sent to the device from the host. This is generally used to seperate + /** CDC class driver event for a send break request sent to the device from the host. This is generally used to separate * data or to indicate a special condition to the receiving device. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state @@ -277,7 +277,7 @@ */ void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular + /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created * stream is bidirectional and can be used for both input and output functions. * diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 20a4062bc..b365b55fd 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -129,7 +129,7 @@ /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the - * \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events. + * \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index ece23c546..72148faad 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -190,7 +190,7 @@ */ uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** Sends a Send Break request to the device. This is generally used to seperate data data or to indicate a special condition + /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition * to the receiving device. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state @@ -267,7 +267,7 @@ */ uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular + /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular * functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created * stream is bidirectional and can be used for both input and output functions. * diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 017e2f6d0..e8717d058 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -136,7 +136,7 @@ * \param[in] reportitem HID Report Item whose retrieved value is to be aligned * \param[in] type Data type to align the HID report item's value to * - * \return Left-aligned data of the given report item's pre-retrived value for the given datatype + * \return Left-aligned data of the given report item's pre-retrieved value for the given datatype */ #define HID_ALIGN_DATA(reportitem, type) ((type)(reportitem->Value << ((8 * sizeof(type)) - reportitem->Attributes.BitSize))) diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index 5ac1becb8..8c711ccf9 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -142,7 +142,7 @@ MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the - * \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the + * \ref MIDI_Host_SendEventPacket() function's packing behavior, to flush queued events. Events are queued into the * pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI * events to be packed into a single pipe packet, increasing data throughput. * diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.c b/LUFA/Drivers/USB/Class/Host/RNDIS.c index 5fde1c6b4..980e32c18 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.c +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.c @@ -294,7 +294,7 @@ uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInter struct { RNDIS_Set_Message_t SetMessage; - uint8_t ContigiousBuffer[Length]; + uint8_t ContiguousBuffer[Length]; } SetMessageData; RNDIS_Set_Complete_t SetMessageResponse; @@ -308,7 +308,7 @@ uint8_t RNDIS_Host_SetRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInter SetMessageData.SetMessage.InformationBufferOffset = (sizeof(RNDIS_Set_Message_t) - sizeof(RNDIS_Message_Header_t)); SetMessageData.SetMessage.DeviceVcHandle = 0; - memcpy(&SetMessageData.ContigiousBuffer, Buffer, Length); + memcpy(&SetMessageData.ContiguousBuffer, Buffer, Length); if ((ErrorCode = RNDIS_SendEncapsulatedCommand(RNDISInterfaceInfo, &SetMessageData, SetMessageData.SetMessage.MessageLength)) != HOST_SENDCONTROL_Successful) @@ -337,7 +337,7 @@ uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInt struct { RNDIS_Query_Complete_t QueryMessageResponse; - uint8_t ContigiousBuffer[MaxLength]; + uint8_t ContiguousBuffer[MaxLength]; } QueryMessageResponseData; QueryMessage.MessageType = REMOTE_NDIS_QUERY_MSG; @@ -364,7 +364,7 @@ uint8_t RNDIS_Host_QueryRNDISProperty(USB_ClassInfo_RNDIS_Host_t* const RNDISInt if (QueryMessageResponseData.QueryMessageResponse.Status != REMOTE_NDIS_STATUS_SUCCESS) return RNDIS_COMMAND_FAILED; - memcpy(Buffer, &QueryMessageResponseData.ContigiousBuffer, MaxLength); + memcpy(Buffer, &QueryMessageResponseData.ContiguousBuffer, MaxLength); return HOST_SENDCONTROL_Successful; } diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h index 91ed492fa..90e36a4cd 100644 --- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h +++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h @@ -214,11 +214,11 @@ const uint8_t AfterType) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); - /** Searches for the next descriptor in the given configuration descriptor using a premade comparator + /** Searches for the next descriptor in the given configuration descriptor using a pre-made comparator * function. The routine updates the position and remaining configuration descriptor bytes values * automatically. If a comparator routine fails a search, the descriptor pointer is retreated back * so that the next descriptor search invocation will start from the descriptor which first caused the - * original search to fail. This behaviour allows for one comparator to be used immediately after another + * original search to fail. This behavior allows for one comparator to be used immediately after another * has failed, starting the second search from the descriptor which failed the first. * * Comparator functions should be standard functions which accept a pointer to the header of the current diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h index e8984a419..7e82ff36d 100644 --- a/LUFA/Drivers/USB/HighLevel/Events.h +++ b/LUFA/Drivers/USB/HighLevel/Events.h @@ -188,7 +188,7 @@ * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller. * this means that the current connection state is derived from the bus suspension and wake up events by default, * which is not always accurate (host may suspend the bus while still connected). If the actual connection state - * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by + * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by * passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection * and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually. * \n\n @@ -206,7 +206,7 @@ * \note For the smaller series 2 USB AVRs with limited USB controllers, VBUS is not available to the USB controller. * this means that the current connection state is derived from the bus suspension and wake up events by default, * which is not always accurate (host may suspend the bus while still connected). If the actual connection state - * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by + * needs to be determined, VBUS should be routed to an external pin, and the auto-detect behavior turned off by * passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection * and disconnection events may be manually fired, and the \ref USB_DeviceState global changed manually. * \n\n @@ -226,7 +226,7 @@ * This event is time-critical; each packet within the request transaction must be acknowledged or * sent within 50ms or the host will abort the transfer. * - * The library interally handles all standard control requests with the exceptions of SYNC FRAME, + * The library internally handles all standard control requests with the exceptions of SYNC FRAME, * SET DESCRIPTOR and SET INTERFACE. These and all other non-standard control requests will be left * for the user to process via this event if desired. If not handled in the user application, requests * are automatically STALLed. @@ -307,7 +307,7 @@ * millisecond timer source when the USB bus is enumerated in device mode to a USB host. * * This event is time-critical; it is run once per millisecond and thus long handlers will significantly - * degrade device performance. This event should only be enabled when needed to reduce device wakeups. + * degrade device performance. This event should only be enabled when needed to reduce device wake-ups. * * \note This event is not normally active - it must be manually enabled and disabled via the * \ref USB_Device_EnableSOFEvents() and \ref USB_Device_DisableSOFEvents() commands after enumeration. diff --git a/LUFA/Drivers/USB/LowLevel/DevChapter9.h b/LUFA/Drivers/USB/LowLevel/DevChapter9.h index 41246ec38..8568cff25 100644 --- a/LUFA/Drivers/USB/LowLevel/DevChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/DevChapter9.h @@ -31,7 +31,7 @@ /** \file * \brief USB device standard request management. * - * This file contains the function prototypes neccesary for the processing of incomming standard control requests + * This file contains the function prototypes necessary for the processing of incoming standard control requests * when the library is in USB device mode. * * \note This file should not be included directly. It is automatically included as needed by the USB driver diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h index fef6b43c2..736ed87cf 100644 --- a/LUFA/Drivers/USB/LowLevel/Host.h +++ b/LUFA/Drivers/USB/LowLevel/Host.h @@ -223,7 +223,7 @@ * \note After this routine returns, the control pipe will be selected. * * \param[in] Index Index of the string index to retrieve - * \param[out] Buffer Pointer to the destination buffer where the retrieved string decriptor is + * \param[out] Buffer Pointer to the destination buffer where the retrieved string descriptor is * to be stored * \param[in] BufferLength Maximum size of the string descriptor which can be stored into the buffer * diff --git a/LUFA/Drivers/USB/LowLevel/HostChapter9.h b/LUFA/Drivers/USB/LowLevel/HostChapter9.h index ab8348d4c..0518855ad 100644 --- a/LUFA/Drivers/USB/LowLevel/HostChapter9.h +++ b/LUFA/Drivers/USB/LowLevel/HostChapter9.h @@ -31,7 +31,7 @@ /** \file * \brief USB host standard request management. * - * This file contains the function prototypes neccesary for the issuing of outgoing standard control requests + * This file contains the function prototypes necessary for the issuing of outgoing standard control requests * when the library is in USB host mode. * * \note This file should not be included directly. It is automatically included as needed by the USB driver diff --git a/LUFA/Drivers/USB/LowLevel/LowLevel.h b/LUFA/Drivers/USB/LowLevel/LowLevel.h index df9d3bb1c..4f27216b1 100644 --- a/LUFA/Drivers/USB/LowLevel/LowLevel.h +++ b/LUFA/Drivers/USB/LowLevel/LowLevel.h @@ -31,7 +31,7 @@ /** \file * \brief USB low level USB controller definitions. * - * This file contains structures, function prototypes and macros related to the low level configutation of the + * This file contains structures, function prototypes and macros related to the low level configuration of the * USB controller, to start, stop and reset the USB library core. * * \note This file should not be included directly. It is automatically included as needed by the USB driver @@ -250,7 +250,7 @@ * Valid mode masks are \ref USB_MODE_DEVICE, \ref USB_MODE_HOST or \ref USB_MODE_UID. * * \param[in] Options Mask indicating the options which should be used when initializing the USB - * interface to control the USB interface's behaviour. This should be comprised of + * interface to control the USB interface's behavior. This should be comprised of * a USB_OPT_REG_* mask to control the regulator, a USB_OPT_*_PLL mask to control the * PLL, and a USB_DEVICE_OPT_* mask (when the device mode is enabled) to set the device * mode speed. |