Minor documentation fixes to correct formatting and typos.

diff --git a/LUFA/ChangeLog.txt b/LUFA/ChangeLog.txt
index e7ead5b..fac2120 100644 (file)
--- a/LUFA/ChangeLog.txt
+++ b/LUFA/ChangeLog.txt
@@ -42,7 +42,7 @@
   *  - Removed AVRISP_Programmer project due to code quality concerns\r
   *  - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data\r
   *  - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)\r
   *  - Removed AVRISP_Programmer project due to code quality concerns\r
   *  - Fixed CDC demo not sending an empty packet after each transfer to prevent the host from buffering incomming data\r
   *  - Fixed documentation typos and preprocessor checks relating to misspellings of the USE_RAM_DESCRIPTORS token (thanks to Ian Gregg)\r

-  *  - Fixed USBTask.h not conditionally including HostChapter9.h only when CAN_BE_DEVICE is defined (thanks to Ian Gregg)\r
+  *  - Fixed USBTask.h not conditionally including HostChapter9.h only when USB_CAN_BE_HOST is defined (thanks to Ian Gregg)\r

   *  - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)\r
   *  - Added new GenericHID device demo application\r
   *\r
   *  - Fixed incorrect ADC driver init register manipulation (thanks to Tobias)\r
   *  - Added new GenericHID device demo application\r
   *\r

diff --git a/LUFA/CompileTimeTokens.txt b/LUFA/CompileTimeTokens.txt
index e93e1ad..53cf9e4 100644 (file)
--- a/LUFA/CompileTimeTokens.txt
+++ b/LUFA/CompileTimeTokens.txt
@@ -10,6 +10,7 @@
  *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,\r
  *  or remove features unused by a given application in order to save flash space.\r
  *\r
  *  compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour,\r
  *  or remove features unused by a given application in order to save flash space.\r
  *\r

+ *\r

  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens\r
  *  This section describes compile tokens which affect non-USB sections of the LUFA library.\r
  *\r
  *  \section Sec_SummaryNonUSBTokens Non USB Related Tokens\r
  *  This section describes compile tokens which affect non-USB sections of the LUFA library.\r
  *\r


@@ -31,6 +32,7 @@
  *  Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver\r
  *  simultaneously, before a handle (and its associated allocated memory) must be freed.\r
  *\r
  *  Sets the maximum number of managed memory handles which can be handed out by the dynamic memory allocation driver\r
  *  simultaneously, before a handle (and its associated allocated memory) must be freed.\r
  *\r

+ *\r

  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens\r
  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.\r
  *\r
  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens\r
  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.\r
  *\r


@@ -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\r
  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
  *\r
  *  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\r
  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
  *\r

+ *\r

  *  \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
  *\r
  *  \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
  *\r

diff --git a/LUFA/Drivers/USB/LowLevel/StreamCallbacks.h b/LUFA/Drivers/USB/LowLevel/StreamCallbacks.h
index 60e408e..891f2f5 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/StreamCallbacks.h
+++ b/LUFA/Drivers/USB/LowLevel/StreamCallbacks.h
@@ -62,8 +62,8 @@
                         *\r
                         *  //...\r
                         *  // Inside some routine:\r
                         *\r
                         *  //...\r
                         *  // Inside some routine:\r

-                        *  if (Endpoint_Write_CStream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) == \r
-                        *                                ENDPOINT_RWSTREAM_ERROR_CallbackAborted)\r
+                        *  if (Endpoint_Write_Stream_LE(DataBuffer, sizeof(DataBuffer), GlobalNotSet) == \r
+                        *                               ENDPOINT_RWSTREAM_ERROR_CallbackAborted)\r

                         *  {\r
                         *      // Do something when the callback aborted the transfer early\r
                         *  }\r
                         *  {\r
                         *      // Do something when the callback aborted the transfer early\r
                         *  }\r


@@ -81,7 +81,7 @@
                        enum StreamCallback_Return_ErrorCodes_t\r
                        {\r
                                STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */\r
                        enum StreamCallback_Return_ErrorCodes_t\r
                        {\r
                                STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */\r

-                               STREAMCALLBACK_Abort               = 1, /**< Abort the stream send or reciving process. */\r
+                               STREAMCALLBACK_Abort               = 1, /**< Abort the stream send or receiving process. */\r

                        };\r
                        \r
 #endif\r
                        };\r
                        \r
 #endif\r

diff --git a/LUFA/GettingStarted.txt b/LUFA/GettingStarted.txt
index efd5ce2..1ff36ec 100644 (file)
--- a/LUFA/GettingStarted.txt
+++ b/LUFA/GettingStarted.txt
@@ -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\r
  *  USB demonstration board to date.\r
  *\r
  *  This is due to two reasons; one, it is the hardware the author posesses, and two, it is the most popular Atmel\r
  *  USB demonstration board to date.\r
  *\r

+ *\r

  *  \section Sec_Prerequisites Prerequisites\r
  *  Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+)\r
  *  and the AVR-GCC (4.2+) compiler. For Windows users, the best way to obtain these is the WinAVR project\r
  *  (http://winavr.sourceforge.net) as this provides a single-file setup for everything required to compile your\r
  *  own AVR projects.\r
  *\r
  *  \section Sec_Prerequisites Prerequisites\r
  *  Before you can compile any of the LUFA library code or demos, you will need a recent distribution of avr-libc (1.6.2+)\r
  *  and the AVR-GCC (4.2+) compiler. For Windows users, the best way to obtain these is the WinAVR project\r
  *  (http://winavr.sourceforge.net) as this provides a single-file setup for everything required to compile your\r
  *  own AVR projects.\r
  *\r

+ *\r

  *  \section Sec_Configuring Configuring the Demos, Bootloaders and Projects\r
  *  If the target AVR model, clock speed, board or other settings are different to the current settings, they must be changed\r
  *  and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project\r
  *  \section Sec_Configuring Configuring the Demos, Bootloaders and Projects\r
  *  If the target AVR model, clock speed, board or other settings are different to the current settings, they must be changed\r
  *  and the project recompiled from the source code before being programmed into the AVR microcontroller. Most project\r


@@ -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\r
  *  configuration parameters.\r
  *\r
  *  interface speed (Low or Full speed) and other LUFA configuration options can be set here - refer to the library documentation for details on the\r
  *  configuration parameters.\r
  *\r

+ *\r

  *  \section Sec_Compiling Compiling a LUFA Application\r
  *  Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for\r
  *  each individual demo, bootloader and project folder, as well as scripts in the /Demos/, /Bootloaders/, /Projects/\r
  *  \section Sec_Compiling Compiling a LUFA Application\r
  *  Compiling the LUFA demos, applications and/or bootloaders is very simple. LUFA comes with makefile scripts for\r
  *  each individual demo, bootloader and project folder, as well as scripts in the /Demos/, /Bootloaders/, /Projects/\r


@@ -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\r
  *  use of the external project makefile, thus the procedure for configuring a demo remains the same regardless of the build environment.\r
  *\r
  *  in AVRStudio, the project can be built and cleaned using the GUI buttons or menus. Note that the AVRStudio project files make\r
  *  use of the external project makefile, thus the procedure for configuring a demo remains the same regardless of the build environment.\r
  *\r

+ *\r

  *  \section Sec_Programming Programming a USB AVR\r
  *  Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your\r
  *  application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the\r
  *  \section Sec_Programming Programming a USB AVR\r
  *  Once you have built an application, you will need a way to program in the resulting ".HEX" file (and, if your\r
  *  application uses EEPROM variables with initial values, also a ".EEP" file) into your USB AVR. Normally, the\r

diff --git a/LUFA/MainPage.txt b/LUFA/MainPage.txt
index f0524a1..00eb8fc 100644 (file)
--- a/LUFA/MainPage.txt
+++ b/LUFA/MainPage.txt
@@ -23,6 +23,7 @@
  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, \r
  *  from the the WinAVR website.\r
  *\r
  *  library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, \r
  *  from the the WinAVR website.\r
  *\r

+ *\r

  *  \section Sec_Links Library Links\r
  *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n\r
  *  Development Blog: http://www.fourwalledcubicle.com/blog \n\r
  *  \section Sec_Links Library Links\r
  *  Project Homepage: http://www.fourwalledcubicle.com/LUFA.php \n\r
  *  Development Blog: http://www.fourwalledcubicle.com/blog \n\r


@@ -35,6 +36,7 @@
  *\r
  *  USB-IF Website: http://www.usb.org \n\r
  *\r
  *\r
  *  USB-IF Website: http://www.usb.org \n\r
  *\r

+ *\r

  *  \section Sec_License License\r
  *  The LUFA library is currently released under the MIT licence, included below.\r
  *\r
  *  \section Sec_License License\r
  *  The LUFA library is currently released under the MIT licence, included below.\r
  *\r


@@ -64,6 +66,7 @@
  *  this software.\r
  *  \endverbatim\r
  *\r
  *  this software.\r
  *  \endverbatim\r
  *\r

+ *\r

  *  \section Sec_Demos Demos and Bootloaders\r
  *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.\r
  *  If this directory is missing, please re-download the project from the project homepage.\r
  *  \section Sec_Demos Demos and Bootloaders\r
  *  The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory.\r
  *  If this directory is missing, please re-download the project from the project homepage.\r


@@ -72,6 +75,7 @@
  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, and\r
  *  the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP.\r
  *\r
  *  The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, and\r
  *  the CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP.\r
  *\r

+ *\r

  *  \section Sec_Donations Donate\r
  *  I am a 20 year old University student studying for a double degree in Computer Science and Electronics\r
  *  Engineering. This leaves little time for any sort of work or leisure. Please consider donating a small amount\r
  *  \section Sec_Donations Donate\r
  *  I am a 20 year old University student studying for a double degree in Computer Science and Electronics\r
  *  Engineering. This leaves little time for any sort of work or leisure. Please consider donating a small amount\r

diff --git a/LUFA/MigrationInformation.txt b/LUFA/MigrationInformation.txt
index 59dc24b..cf10447 100644 (file)
--- a/LUFA/MigrationInformation.txt
+++ b/LUFA/MigrationInformation.txt
@@ -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\r
  *      modifications required.\r
  *\r
  *      NO_CLEARSET_FEATURE_REQUEST compile time token, it can be replaced with the FEATURELESS_CONTROL_ONLY_DEVICE token with no further\r
  *      modifications required.\r
  *\r

+ *\r

  * \section Sec_Migration090209 Migrating from 081217 to 090209\r
  *\r
  *  <b>Device Mode</b>\r
  * \section Sec_Migration090209 Migrating from 081217 to 090209\r
  *\r
  *  <b>Device Mode</b>\r


@@ -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\r
  *      the latest demo versions.\r
  *\r
  *    - Most library demos have been enhanced and/or had errors corrected. All users of all demos should upgrade their codebase to\r
  *      the latest demo versions.\r
  *\r

+ *\r

  * \section Sec_Migration171208 Migrating from V1.5.3 to 081217\r
  *\r
  *  <b>All</b>\r
  * \section Sec_Migration171208 Migrating from V1.5.3 to 081217\r
  *\r
  *  <b>All</b>\r