diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-06-05 13:55:56 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-06-05 13:55:56 +0000 |
commit | 7dffa15c1670806cc053b9930f341b53e30f7384 (patch) | |
tree | b06af7dc2e6e2cf9f5bf20cb848cff5ee3f527c8 /Demos | |
parent | 0210fa5648b1ed65caa384f966ac40b4ecc489ae (diff) | |
download | lufa-7dffa15c1670806cc053b9930f341b53e30f7384.tar.gz lufa-7dffa15c1670806cc053b9930f341b53e30f7384.tar.bz2 lufa-7dffa15c1670806cc053b9930f341b53e30f7384.zip |
Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.
Diffstat (limited to 'Demos')
38 files changed, 54 insertions, 54 deletions
diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.h b/Demos/Device/ClassDriver/AudioInput/AudioInput.h index 8743d8b06..47f2d3d47 100644 --- a/Demos/Device/ClassDriver/AudioInput/AudioInput.h +++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.h @@ -57,7 +57,7 @@ /** ADC channel MUX mask for the microphone input. */ #define MIC_IN_ADC_MUX_MASK ADC_CHANNEL2 - /** Maximum ADC sample value for the microphone input. */ + /** Maximum audio sample value for the microphone input. */ #define SAMPLE_MAX_RANGE 0xFFFF /** Maximum ADC range for the microphone input. */ diff --git a/Demos/Device/ClassDriver/GenericHID/GenericHID.c b/Demos/Device/ClassDriver/GenericHID/GenericHID.c index c6b857042..7eea008c5 100644 --- a/Demos/Device/ClassDriver/GenericHID/GenericHID.c +++ b/Demos/Device/ClassDriver/GenericHID/GenericHID.c @@ -165,7 +165,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/Joystick/Joystick.c b/Demos/Device/ClassDriver/Joystick/Joystick.c index 3a8897fa8..6b8ffe256 100644 --- a/Demos/Device/ClassDriver/Joystick/Joystick.c +++ b/Demos/Device/ClassDriver/Joystick/Joystick.c @@ -175,7 +175,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/Keyboard/Keyboard.c b/Demos/Device/ClassDriver/Keyboard/Keyboard.c index 42ea12d80..302f451ce 100644 --- a/Demos/Device/ClassDriver/Keyboard/Keyboard.c +++ b/Demos/Device/ClassDriver/Keyboard/Keyboard.c @@ -177,7 +177,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c index 8b30c463e..ed9056d59 100644 --- a/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c +++ b/Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.c @@ -232,7 +232,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c index 307e330d3..727f2327c 100644 --- a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c +++ b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/KeyboardMouseMultiReport.c @@ -198,7 +198,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/MIDI/MIDI.h b/Demos/Device/ClassDriver/MIDI/MIDI.h index effe7329c..0cb10f319 100644 --- a/Demos/Device/ClassDriver/MIDI/MIDI.h +++ b/Demos/Device/ClassDriver/MIDI/MIDI.h @@ -30,7 +30,7 @@ /** \file * - * Header file for AudioOutput.c. + * Header file for MIDI.c. */ #ifndef _AUDIO_OUTPUT_H_ diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c index b02b65fc1..f962729dc 100644 --- a/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c +++ b/Demos/Device/ClassDriver/MassStorage/Lib/DataflashManager.c @@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn return; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } @@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, BytesInBlockDiv16++; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c index b02b65fc1..f962729dc 100644 --- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c +++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/DataflashManager.c @@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn return; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } @@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, BytesInBlockDiv16++; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c index f891ec914..d96fd2b9f 100644 --- a/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c +++ b/Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c @@ -222,7 +222,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/Mouse/Mouse.c b/Demos/Device/ClassDriver/Mouse/Mouse.c index bc0153f08..070b48199 100644 --- a/Demos/Device/ClassDriver/Mouse/Mouse.c +++ b/Demos/Device/ClassDriver/Mouse/Mouse.c @@ -93,13 +93,13 @@ void SetupHardware(void) USB_Init(); } -/** Event handler for the library USB WakeUp event. */ +/** Event handler for the library USB Connection event. */ void EVENT_USB_Device_Connect(void) { LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); } -/** Event handler for the library USB Suspend event. */ +/** Event handler for the library USB Disconnection event. */ void EVENT_USB_Device_Disconnect(void) { LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); @@ -175,7 +175,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c index 71f7df173..a49995ccc 100644 --- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c +++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.c @@ -170,7 +170,7 @@ void TCP_Init(void) /** Sets the state and callback handler of the given port, specified in big endian to the given state. * * \param[in] Port Port whose state and callback function to set, specified in big endian - * \param[in] State New state of the port, a value from the TCP_PortStates_t enum + * \param[in] State New state of the port, a value from the \ref TCP_PortStates_t enum * \param[in] Handler Application callback handler for the port * * \return Boolean true if the port state was set, false otherwise (no more space in the port state table) @@ -222,7 +222,7 @@ bool TCP_SetPortState(const uint16_t Port, * * \param[in] Port TCP port whose state is to be retrieved, given in big-endian * - * \return A value from the TCP_PortStates_t enum + * \return A value from the \ref TCP_PortStates_t enum */ uint8_t TCP_GetPortState(const uint16_t Port) { @@ -245,7 +245,7 @@ uint8_t TCP_GetPortState(const uint16_t Port) * \param[in] Port TCP port of the connection on the device, specified in big endian * \param[in] RemoteAddress Remote protocol IP address of the connected device * \param[in] RemotePort TCP port of the remote device in the connection, specified in big endian - * \param[in] State TCP connection state, a value from the TCP_ConnectionStates_t enum + * \param[in] State TCP connection state, a value from the \ref TCP_ConnectionStates_t enum * * \return Boolean true if the connection was updated or created, false otherwise (no more space in the connection state table) */ @@ -290,7 +290,7 @@ bool TCP_SetConnectionState(const uint16_t Port, * \param[in] RemoteAddress Remote protocol IP address of the connected host * \param[in] RemotePort Remote TCP port of the connected host, specified in big endian * - * \return A value from the TCP_ConnectionStates_t enum + * \return A value from the \ref TCP_ConnectionStates_t enum */ uint8_t TCP_GetConnectionState(const uint16_t Port, const IP_Address_t RemoteAddress, diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h index aad63a4fe..f1b583530 100644 --- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h +++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h @@ -197,14 +197,14 @@ uint16_t RemotePort; /**< Connection port number on the host */ IP_Address_t RemoteAddress; /**< Connection protocol IP address of the host */ TCP_ConnectionInfo_t Info; /**< Connection information, including application buffer */ - uint8_t State; /**< Current connection state, a value from the TCP_ConnectionStates_t enum */ + uint8_t State; /**< Current connection state, a value from the \ref TCP_ConnectionStates_t enum */ } TCP_ConnectionState_t; /** Type define for a TCP port state. */ typedef struct { uint16_t Port; /**< TCP port number on the device */ - uint8_t State; /**< Current port state, a value from the TCP_PortStates_t enum */ + uint8_t State; /**< Current port state, a value from the \ref TCP_PortStates_t enum */ void (*ApplicationHandler) (TCP_ConnectionState_t* ConnectionState, TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */ } TCP_PortState_t; diff --git a/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h b/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h index 7549d40ed..847c4fa9b 100644 --- a/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h +++ b/Demos/Device/ClassDriver/RNDISEthernet/Lib/UDP.h @@ -30,7 +30,7 @@ /** \file * - * Header file for IP.c. + * Header file for UDP.c. */ #ifndef _UDP_H_ diff --git a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c index 7100acb3e..64573520a 100644 --- a/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c +++ b/Demos/Device/ClassDriver/VirtualSerialMassStorage/Lib/DataflashManager.c @@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn return;
}
- /* Decrement the blocks remaining counter and reset the sub block counter */
+ /* Decrement the blocks remaining counter */
TotalBlocks--;
}
@@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, BytesInBlockDiv16++;
}
- /* Decrement the blocks remaining counter and reset the sub block counter */
+ /* Decrement the blocks remaining counter */
TotalBlocks--;
}
diff --git a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c index 849e0634c..563794efe 100644 --- a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c +++ b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c @@ -234,7 +234,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Device/LowLevel/AudioInput/AudioInput.h b/Demos/Device/LowLevel/AudioInput/AudioInput.h index 33b0a3bbf..233318aa3 100644 --- a/Demos/Device/LowLevel/AudioInput/AudioInput.h +++ b/Demos/Device/LowLevel/AudioInput/AudioInput.h @@ -57,7 +57,7 @@ /** ADC channel MUX mask for the microphone input. */ #define MIC_IN_ADC_MUX_MASK ADC_CHANNEL2 - /** Maximum ADC sample value for the microphone input. */ + /** Maximum audio sample value for the microphone input. */ #define SAMPLE_MAX_RANGE 0xFFFF /** Maximum ADC range for the microphone input. */ diff --git a/Demos/Device/LowLevel/GenericHID/GenericHID.c b/Demos/Device/LowLevel/GenericHID/GenericHID.c index e8d0e41d2..70ca0a5ce 100644 --- a/Demos/Device/LowLevel/GenericHID/GenericHID.c +++ b/Demos/Device/LowLevel/GenericHID/GenericHID.c @@ -148,9 +148,9 @@ void EVENT_USB_Device_ControlRequest(void) } } -/** Function to process the lest received report from the host. +/** Function to process the last received report from the host. * - * \param[in] DataArray Pointer to a buffer where the last report data is stored + * \param[in] DataArray Pointer to a buffer where the last received report has been stored */ void ProcessGenericHIDReport(uint8_t* DataArray) { diff --git a/Demos/Device/LowLevel/Keyboard/Keyboard.c b/Demos/Device/LowLevel/Keyboard/Keyboard.c index 5cf547389..2d5e366ba 100644 --- a/Demos/Device/LowLevel/Keyboard/Keyboard.c +++ b/Demos/Device/LowLevel/Keyboard/Keyboard.c @@ -122,7 +122,7 @@ void EVENT_USB_Device_ConfigurationChanged(void) ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE); - /* Turn on Start-of-Frame events for tracking HID report period exiry */ + /* Turn on Start-of-Frame events for tracking HID report period expiry */ USB_Device_EnableSOFEvents(); /* Indicate endpoint configuration success or failure */ diff --git a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c index 287676fd0..2100eb21f 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c +++ b/Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c @@ -155,7 +155,7 @@ void DataflashManager_WriteBlocks(const uint32_t BlockAddress, return; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } @@ -367,7 +367,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, BytesInBlockDiv16++; } - /* Decrement the blocks remaining counter and reset the sub block counter */ + /* Decrement the blocks remaining counter */ TotalBlocks--; } diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c index 4d04bd8dc..1c0117792 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c @@ -89,7 +89,7 @@ RNDIS_Message_Header_t* MessageHeader = (RNDIS_Message_Header_t*)&RNDISMessageBu /** Indicates if a RNDIS message response is ready to be sent back to the host. */ bool ResponseReady = false; -/** Current RNDIS adapter state, a value from the RNDIS_States_t enum. */ +/** Current RNDIS adapter state, a value from the \ref RNDIS_States_t enum. */ uint8_t CurrRNDISState = RNDIS_Uninitialized; /** Current Ethernet packet filter mask. This is non-zero when the adapter is initialized, or zero when disabled. */ diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c index d469f686f..c8a12da7c 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c @@ -169,7 +169,7 @@ void TCP_Init(void) /** Sets the state and callback handler of the given port, specified in big endian to the given state. * * \param[in] Port Port whose state and callback function to set, specified in big endian - * \param[in] State New state of the port, a value from the TCP_PortStates_t enum + * \param[in] State New state of the port, a value from the \ref TCP_PortStates_t enum * \param[in] Handler Application callback handler for the port * * \return Boolean true if the port state was set, false otherwise (no more space in the port state table) @@ -221,7 +221,7 @@ bool TCP_SetPortState(const uint16_t Port, * * \param[in] Port TCP port whose state is to be retrieved, given in big-endian * - * \return A value from the TCP_PortStates_t enum + * \return A value from the \ref TCP_PortStates_t enum */ uint8_t TCP_GetPortState(const uint16_t Port) { @@ -244,7 +244,7 @@ uint8_t TCP_GetPortState(const uint16_t Port) * \param[in] Port TCP port of the connection on the device, specified in big endian * \param[in] RemoteAddress Remote protocol IP address of the connected device * \param[in] RemotePort TCP port of the remote device in the connection, specified in big endian - * \param[in] State TCP connection state, a value from the TCP_ConnectionStates_t enum + * \param[in] State TCP connection state, a value from the \ref TCP_ConnectionStates_t enum * * \return Boolean true if the connection was updated or created, false otherwise (no more space in the connection state table) */ @@ -289,7 +289,7 @@ bool TCP_SetConnectionState(const uint16_t Port, * \param[in] RemoteAddress Remote protocol IP address of the connected host * \param[in] RemotePort Remote TCP port of the connected host, specified in big endian * - * \return A value from the TCP_ConnectionStates_t enum + * \return A value from the \ref TCP_ConnectionStates_t enum */ uint8_t TCP_GetConnectionState(const uint16_t Port, const IP_Address_t RemoteAddress, diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h index 373ff5baa..9aad5630d 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h @@ -198,14 +198,14 @@ uint16_t RemotePort; /**< Connection port number on the host */ IP_Address_t RemoteAddress; /**< Connection protocol IP address of the host */ TCP_ConnectionInfo_t Info; /**< Connection information, including application buffer */ - uint8_t State; /**< Current connection state, a value from the TCP_ConnectionStates_t enum */ + uint8_t State; /**< Current connection state, a value from the \ref TCP_ConnectionStates_t enum */ } TCP_ConnectionState_t; /** Type define for a TCP port state. */ typedef struct { uint16_t Port; /**< TCP port number on the device */ - uint8_t State; /**< Current port state, a value from the TCP_PortStates_t enum */ + uint8_t State; /**< Current port state, a value from the \ref TCP_PortStates_t enum */ void (*ApplicationHandler) (TCP_ConnectionState_t* ConnectionState, TCP_ConnectionBuffer_t* Buffer); /**< Port application handler */ } TCP_PortState_t; diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h b/Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h index 85ef5a65f..13f7d0dfb 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h @@ -30,7 +30,7 @@ /** \file * - * Header file for IP.c. + * Header file for UDP.c. */ #ifndef _UDP_H_ diff --git a/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c b/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c index 74c4b0908..5d2c9f7d9 100644 --- a/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c +++ b/Demos/DualRole/ClassDriver/MouseHostDevice/DeviceFunctions.c @@ -140,7 +140,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn * \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced * \param[in] ReportID Report ID of the received report from the host * \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature - * \param[in] ReportData Pointer to a buffer where the created report has been stored + * \param[in] ReportData Pointer to a buffer where the received report has been stored * \param[in] ReportSize Size in bytes of the received HID report */ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, diff --git a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt index 30d111281..c9669ad33 100644 --- a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt +++ b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt @@ -42,7 +42,7 @@ * \section Sec_Description Project Description: * * Keyboard host demonstration application. This gives a simple reference - * application for implementing a USB keyboard, for USB keyboards using + * application for implementing a USB keyboard host, for USB keyboards using * the standard keyboard HID profile. * * Pressed alpha-numeric, enter or space key is transmitted through the serial diff --git a/Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt b/Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt index 6b00675bf..7a8d5138b 100644 --- a/Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt +++ b/Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt @@ -46,7 +46,7 @@ * * This demo prints out received CDC data through the serial port. * - * Not that this demo is only compatible with devices which report the correct CDC + * Note that this demo is only compatible with devices which report the correct CDC * and ACM class, subclass and protocol values. Most USB-Serial cables have vendor * specific features, thus use vendor-specific class/subclass/protocol codes to force * the user to use specialized drivers. This demo is not compatible with such devices. diff --git a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c index 3a131875e..10a24d587 100644 --- a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c +++ b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c @@ -78,7 +78,7 @@ uint8_t ProcessConfigurationDescriptor(void) while (!(DataINEndpoint) || !(DataOUTEndpoint)) { - /* Get the next Still Image interface's data endpoint descriptor */ + /* Get the next Bluetooth interface's data endpoint descriptor */ if (USB_GetNextDescriptorComp(&CurrConfigBytesRem, &CurrConfigLocation, DComp_NextInterfaceBluetoothDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found) { diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h index c32b52e25..953a5a14a 100644 --- a/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h +++ b/Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h @@ -146,7 +146,7 @@ /** Configuration Request signaling command structure, for channel configuration requests. */ typedef struct { - uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */ + uint16_t DestinationChannel; /**< Destination channel address which is to be configured */ uint16_t Flags; /**< Configuration flags for the request, including command continuation */ } BT_Signal_ConfigurationReq_t; diff --git a/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h b/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h index 35d536a13..d580737a0 100644 --- a/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h +++ b/Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h @@ -70,7 +70,7 @@ uint16_t B; /**< Bits 32-47 of the UUID. */ uint16_t C; /**< Bits 48-63 of the UUID. */ uint16_t D; /**< Bits 64-79 of the UUID. */ - uint8_t E[6]; /**< Bits 80-128 of the UUID. */ + uint8_t E[6]; /**< Bits 80-127 of the UUID. */ } UUID_t; /** Structure for the association of attribute ID values to an attribute value in FLASH. A table of these @@ -152,7 +152,7 @@ struct { ItemUUID_t UUID; /**< UUID to store in the protocol list Data Element sequence */ - Item16Bit_t Channel; /**< 8-Bit Parameter associated with the service */ + Item16Bit_t Channel; /**< 16-Bit Parameter associated with the service */ } Protocol; } ItemProtocol_16BitParam_t; diff --git a/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h b/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h index 90d7badd8..0caaae933 100644 --- a/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h +++ b/Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h @@ -30,7 +30,7 @@ /** \file * - * Header file for MouseHost.c. + * Header file for GenericHIDHost.c. */ #ifndef _GENERICHID_HOST_H_ diff --git a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c index b2d073f96..848781d91 100644 --- a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c +++ b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c @@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo; /** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read * structures via the HID parser routines in the LUFA library. * - * \return A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum + * \return A value from the \ref JoystickHostWithParser_GetHIDReportDataCodes_t enum */ uint8_t GetHIDReportData(void) { diff --git a/Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt b/Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt index 29cefbaea..2dd1e915d 100644 --- a/Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt +++ b/Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt @@ -44,7 +44,7 @@ * \section Sec_Description Project Description: * * Keyboard host demonstration application. This gives a simple reference - * application for implementing a USB keyboard, for USB keyboards using + * application for implementing a USB keyboard host, for USB keyboards using * the standard keyboard HID profile. * * Pressed alpha-numeric, enter or space key is transmitted through the serial diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c index 1d2948457..37eb83395 100644 --- a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c +++ b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c @@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo; /** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read * structures via the HID parser routines in the LUFA library. * - * \return A value from the KeyboardHostWithParser_GetHIDReportDataCodes_t enum + * \return A value from the \ref KeyboardHostWithParser_GetHIDReportDataCodes_t enum */ uint8_t GetHIDReportData(void) { diff --git a/Demos/Host/LowLevel/MouseHost/MouseHost.c b/Demos/Host/LowLevel/MouseHost/MouseHost.c index 0eeef1d41..c2c900ac7 100644 --- a/Demos/Host/LowLevel/MouseHost/MouseHost.c +++ b/Demos/Host/LowLevel/MouseHost/MouseHost.c @@ -137,7 +137,7 @@ void ReadNextReport(void) /* Select mouse data pipe */ Pipe_SelectPipe(MOUSE_DATA_IN_PIPE); - /* Unfreeze keyboard data pipe */ + /* Unfreeze mouse data pipe */ Pipe_Unfreeze(); /* Check to see if a packet has been received */ diff --git a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c index 084faad13..73aed67d4 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c +++ b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c @@ -40,7 +40,7 @@ HID_ReportInfo_t HIDReportInfo; /** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read * structures via the HID parser routines in the LUFA library. * - * \return A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum + * \return A value from the \ref MouseHostWithParser_GetHIDReportDataCodes_t enum */ uint8_t GetHIDReportData(void) { diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c index 34cb70f11..846a1387a 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c @@ -219,7 +219,7 @@ uint8_t SImage_SendData(void* const Buffer, return ErrorCode; } -/** Function to receive the given data to the device, after a response block has been received. +/** Function to receive the given data from the device, after a response block has been received. * * \param[out] Buffer Destination data buffer to put read bytes from the device * \param[in] Bytes Number of bytes to receive diff --git a/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt b/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt index 6b00675bf..7a8d5138b 100644 --- a/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt +++ b/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt @@ -46,7 +46,7 @@ * * This demo prints out received CDC data through the serial port. * - * Not that this demo is only compatible with devices which report the correct CDC + * Note that this demo is only compatible with devices which report the correct CDC * and ACM class, subclass and protocol values. Most USB-Serial cables have vendor * specific features, thus use vendor-specific class/subclass/protocol codes to force * the user to use specialized drivers. This demo is not compatible with such devices. |