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/Device/LowLevel/AudioInput/AudioInput.h | 2 +- Demos/Device/LowLevel/GenericHID/GenericHID.c | 4 ++-- Demos/Device/LowLevel/Keyboard/Keyboard.c | 2 +- Demos/Device/LowLevel/MassStorage/Lib/DataflashManager.c | 4 ++-- Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c | 2 +- Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.c | 8 ++++---- Demos/Device/LowLevel/RNDISEthernet/Lib/TCP.h | 4 ++-- Demos/Device/LowLevel/RNDISEthernet/Lib/UDP.h | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) (limited to 'Demos/Device/LowLevel') 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_ -- cgit v1.2.3