Minor documentation fixes to correct formatting and typos.

pull/1469/head
Dean Camera 16 years ago
parent dc83f73ca3
commit 3aa8620a61

@ -42,7 +42,7 @@
* - Removed AVRISP_Programmer project due to code quality concerns * - Removed AVRISP_Programmer project due to code quality concerns
* - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data * - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data
* - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg) * - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)
* - Fixed USBTask.h not conditionally including HostChapter9.h only when CAN_BE_DEVICE is defined (thanks to Ian Gregg) * - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)
* - Fixed incorrect ADC driver init register manipulation (thanks to Tobias) * - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)
* - Added new GenericHID device demo application * - Added new GenericHID device demo application
* *

@ -10,6 +10,7 @@
* compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour, * compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,
* or remove features unused by a given application in order to save flash space. * or remove features unused by a given application in order to save flash space.
* *
*
* \section Sec_SummaryNonUSBTokens Non USB Related Tokens * \section Sec_SummaryNonUSBTokens Non USB Related Tokens
* This section describes compile tokens which affect non-USB sections of the LUFA library. * This section describes compile tokens which affect non-USB sections of the LUFA library.
* *
@ -31,6 +32,7 @@
* Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver * Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver
* simultaneously, before a handle (and its associated allocated memory) must be freed. * simultaneously, before a handle (and its associated allocated memory) must be freed.
* *
*
* \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens * \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens
* This section describes compile tokens which affect USB class-specific drivers in the LUFA library. * This section describes compile tokens which affect USB class-specific drivers in the LUFA library.
* *
@ -73,6 +75,7 @@
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed seperately in the * If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed seperately in the
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation. * processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
* *
*
* \section Sec_SummaryUSBTokens USB Driver Related Tokens * \section Sec_SummaryUSBTokens USB Driver Related Tokens
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. * This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
* *

@ -62,8 +62,8 @@
* *
* //... * //...
* // Inside some routine: * // Inside some routine:
* if (Endpoint_Write_CStream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) == * if (Endpoint_Write_Stream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) ==
* ENDPOINT_RWSTREAM_ERROR_CallbackAborted) * ENDPOINT_RWSTREAM_ERROR_CallbackAborted)
* { * {
* // Do something when the callback aborted the transfer early * // Do something when the callback aborted the transfer early
* } * }
@ -81,7 +81,7 @@
enum StreamCallback_Return_ErrorCodes_t enum StreamCallback_Return_ErrorCodes_t
{ {
STREAMCALLBACK_Continue = 0, /**< Continue sending or receiving the stream. */ STREAMCALLBACK_Continue = 0, /**< Continue sending or receiving the stream. */
STREAMCALLBACK_Abort = 1, /**< Abort the stream send or reciving process. */ STREAMCALLBACK_Abort = 1, /**< Abort the stream send or receiving process. */
}; };
#endif #endif

@ -12,12 +12,14 @@
* This is due to two reasons; one, it is the hardware the author posesses, and two, it is the most popular Atmel * This is due to two reasons; one, it is the hardware the author posesses, and two, it is the most popular Atmel
* USB demonstration board to date. * USB demonstration board to date.
* *
*
* \section Sec_Prerequisites Prerequisites * \section Sec_Prerequisites Prerequisites
* Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+) * Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+)
* and the AVR-GCC (4.2+) compiler. For Windows users, the best way to obtain these is the WinAVR project * and the AVR-GCC (4.2+) compiler. For Windows users, the best way to obtain these is the WinAVR project
* (http://winavr.sourceforge.net) as this provides a single-file setup for everything required to compile your * (http://winavr.sourceforge.net) as this provides a single-file setup for everything required to compile your
* own AVR projects. * own AVR projects.
* *
*
* \section Sec_Configuring Configuring the Demos, Bootloaders and Projects * \section Sec_Configuring Configuring the Demos, Bootloaders and Projects
* If the target AVR model, clock speed, board or other settings are different to the current settings, they must be changed * If the target AVR model, clock speed, board or other settings are different to the current settings, they must be changed
* and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project * and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project
@ -84,6 +86,7 @@
* interface speed (Low or Full speed) and other LUFA configuration options can be set here - refer to the library documentation for details on the * interface speed (Low or Full speed) and other LUFA configuration options can be set here - refer to the library documentation for details on the
* configuration parameters. * configuration parameters.
* *
*
* \section Sec_Compiling Compiling a LUFA Application * \section Sec_Compiling Compiling a LUFA Application
* Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for * Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for
* each individual demo, bootloader and project folder, as well as scripts in the /Demos/, /Bootloaders/, /Projects/ * each individual demo, bootloader and project folder, as well as scripts in the /Demos/, /Bootloaders/, /Projects/
@ -104,6 +107,7 @@
* in AVRStudio, the project can be built and cleaned using the GUI buttons or menus. Note that the AVRStudio project files make * in AVRStudio, the project can be built and cleaned using the GUI buttons or menus. Note that the AVRStudio project files make
* use of the external project makefile, thus the procedure for configuring a demo remains the same regardless of the build environment. * use of the external project makefile, thus the procedure for configuring a demo remains the same regardless of the build environment.
* *
*
* \section Sec_Programming Programming a USB AVR * \section Sec_Programming Programming a USB AVR
* Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your * Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your
* application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the * application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the

@ -23,6 +23,7 @@
* library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package,
* from the the WinAVR website. * from the the WinAVR website.
* *
*
* \section Sec_Links Library Links * \section Sec_Links Library Links
* Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n * Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n
* Development Blog: http://www.fourwalledcubicle.com/blog \n * Development Blog: http://www.fourwalledcubicle.com/blog \n
@ -35,6 +36,7 @@
* *
* USB-IF Website: http://www.usb.org \n * USB-IF Website: http://www.usb.org \n
* *
*
* \section Sec_License License * \section Sec_License License
* The LUFA library is currently released under the MIT licence, included below. * The LUFA library is currently released under the MIT licence, included below.
* *
@ -64,6 +66,7 @@
* this software. * this software.
* \endverbatim * \endverbatim
* *
*
* \section Sec_Demos Demos and Bootloaders * \section Sec_Demos Demos and Bootloaders
* The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.
* If this directory is missing, please re-download the project from the project homepage. * If this directory is missing, please re-download the project from the project homepage.
@ -72,6 +75,7 @@
* The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, and * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, and
* the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP. * the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP.
* *
*
* \section Sec_Donations Donate * \section Sec_Donations Donate
* I am a 20 year old University student studying for a double degree in Computer Science and Electronics * I am a 20 year old University student studying for a double degree in Computer Science and Electronics
* Engineering. This leaves little time for any sort of work or leisure. Please consider donating a small amount * Engineering. This leaves little time for any sort of work or leisure. Please consider donating a small amount

@ -36,6 +36,7 @@
* NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further * NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further
* modifications required. * modifications required.
* *
*
* \section Sec_Migration090209 Migrating from 081217 to 090209 * \section Sec_Migration090209 Migrating from 081217 to 090209
* *
* <b>Device Mode</b> * <b>Device Mode</b>
@ -64,6 +65,7 @@
* - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to * - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to
* the latest demo versions. * the latest demo versions.
* *
*
* \section Sec_Migration171208 Migrating from V1.5.3 to 081217 * \section Sec_Migration171208 Migrating from V1.5.3 to 081217
* *
* <b>All</b> * <b>All</b>

Loading…
Cancel
Save