From 7dffa15c1670806cc053b9930f341b53e30f7384 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 5 Jun 2011 13:55:56 +0000 Subject: Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru. --- Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.txt | 2 +- Demos/Host/ClassDriver/VirtualSerialHost/VirtualSerialHost.txt | 2 +- Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.c | 2 +- Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h | 2 +- Demos/Host/Incomplete/BluetoothHost/Lib/SDPServices.h | 4 ++-- Demos/Host/LowLevel/GenericHIDHost/GenericHIDHost.h | 2 +- Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.c | 2 +- Demos/Host/LowLevel/KeyboardHost/KeyboardHost.txt | 2 +- Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c | 2 +- Demos/Host/LowLevel/MouseHost/MouseHost.c | 2 +- Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c | 2 +- Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c | 2 +- Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.txt | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) (limited to 'Demos/Host') 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. -- cgit v1.2.3