Commit 7dffa15c authored by Dean Camera's avatar Dean Camera
Browse files

Massive corrections to the project documentation and code comments, thanks to...

Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.
parent 0210fa56
This diff is collapsed.
......@@ -87,7 +87,7 @@
/** Retrieves a bit from the next location inside a given bit buffer.
*
* \param[in,out] Buffer Bit buffer to store a bit into
* \param[in,out] Buffer Bit buffer to retrieve a bit from
*
* \return Next bit from the buffer
*/
......
......@@ -87,13 +87,11 @@
* </tr>
* </table>
*
* This project is based on the LUFA Keyboard projectnstration application,
* written by Denver Gingerich.
* This project is based on the LUFA Keyboard project demonstration application, written by Denver Gingerich.
*
* This application uses a keyboard HID driver to communicate the data collected
* a TTL magnetic stripe reader to the connected computer. The raw bitstream
* obtained from the magnetic stripe reader is "typed" through the keyboard
* driver as 0's and 1's. After every card swipe, the project will send a return key.
* This application uses a keyboard HID driver to communicate the data collected a TTL magnetic stripe reader
* to the connected computer. The raw bitstream obtained from the magnetic stripe reader is "typed" through
* the keyboard driver as 0's and 1's. After every card swipe, the project will send a return key.
*
* \section Sec_Options Project Options
*
......
......@@ -164,7 +164,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,
......
......@@ -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--;
}
......
......@@ -294,7 +294,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,
......
......@@ -154,6 +154,7 @@ void DHCPServerApp_Callback(void)
* \param[out] DHCPHeader Location in the packet buffer where the BOOTP header should be written to
* \param[in] DHCPMessageType DHCP Message type, such as DHCP_DISCOVER
* \param[in] ClientHardwareAddress Client MAC address the created transaction should be directed to
* \param[in] PreferredClientIP Preferred IP that should be given to the client if it is unallocated
* \param[in] TransactionID Transaction ID the created transaction should be associated with
*
* \return Size in bytes of the created DHCP packet
......
......@@ -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--;
}
......
......@@ -47,7 +47,7 @@ const char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
"Content-Type: ";
/** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
* given URL is invalid, and gives extra error information.
* URL is invalid, and gives extra error information.
*/
const char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
"Server: LUFA " LUFA_VERSION_STRING "\r\n"
......
......@@ -54,7 +54,7 @@ const char PROGMEM TELNETMenu[] = "\r\n"
/** Header to print before the current connections are printed to the client */
const char PROGMEM CurrentConnectionsHeader[] = "\r\n* Current TCP Connections: *\r\n";
/** Initialization function for the simple HTTP webserver. */
/** Initialization function for the simple TELNET webserver. */
void TELNETServerApp_Init(void)
{
/* Listen on port 23 for TELNET connections from hosts */
......
......@@ -74,7 +74,7 @@ timer_set(struct timer *t, clock_time_t interval)
* given to the timer_set() function. The start point of the interval
* is the exact time that the timer last expired. Therefore, this
* function will cause the timer to be stable over time, unlike the
* timer_rester() function.
* timer_restart() function.
*
* \param t A pointer to the timer.
*
......
......@@ -933,7 +933,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
} while(0)
/**
* Construct an IPv6 address from eight 8-bit words.
* Construct an IPv6 address from sixteen 8-bit words.
*
* This function constructs an IPv6 address.
*
......
......@@ -282,15 +282,15 @@
*/
/**
* Toggles whether UDP support should be compiled in or not.
* Toggles whether TCP support should be compiled in or not.
*
* \hideinitializer
*/
#ifdef UIP_CONF_TCP
#define UIP_TCP UIP_CONF_TCP
#else /* UIP_CONF_UDP */
#else /* UIP_CONF_TCP */
#define UIP_TCP 1
#endif /* UIP_CONF_UDP */
#endif /* UIP_CONF_TCP */
/**
* Determines if support for opening connections from uIP should be
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment