Minor documentation improvements.

diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index 538214e..aefe344 100644 (file)
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -38,7 +38,8 @@
  *  </tr>
  *  <tr>
  *   <td><b>Supported USB Speeds:</b></td>
  *  </tr>
  *  <tr>
  *   <td><b>Supported USB Speeds:</b></td>

- *   <td>Full Speed Mode</td>
+ *   <td>Low Speed Mode \n
+ *       Full Speed Mode</td>

  *  </tr>
  * </table>
  *
  *  </tr>
  * </table>
  *

diff --git a/Bootloaders/HID/BootloaderHID.h b/Bootloaders/HID/BootloaderHID.h
index a281633..e83aad3 100644 (file)
--- a/Bootloaders/HID/BootloaderHID.h
+++ b/Bootloaders/HID/BootloaderHID.h
@@ -30,11 +30,11 @@
 
 /** \file
  *
 
 /** \file
  *

- *  Header file for TeensyHID.c.
+ *  Header file for BootloaderHID.c.

  */
 
  */
 

-#ifndef _TEENSYHID_H_
-#define _TEENSYHID_H_
+#ifndef _BOOTLOADERHID_H_
+#define _BOOTLOADERHID_H_

 
        /* Includes: */
                #include <avr/io.h>
 
        /* Includes: */
                #include <avr/io.h>

diff --git a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
index 2d98ef4..eb1f928 100644 (file)
--- a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
+++ b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h
@@ -336,8 +336,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -358,8 +358,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -381,7 +381,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -403,7 +403,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.

diff --git a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
index 3eccb7f..551cf4b 100644 (file)
--- a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
+++ b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.h
@@ -336,8 +336,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -358,8 +358,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -381,7 +381,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -403,7 +403,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.

diff --git a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
index 4367528..f2fe289 100644 (file)
--- a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
+++ b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.h
@@ -336,8 +336,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in little endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -358,8 +358,8 @@
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared
 
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,
                         *  sending full packets to the host as needed. The host OUT acknowledgement is not automatically cleared

-                        *  in both failure and success states; the user is responsible for manually clearing the setup OUT to
-                        *  finalize the transfer via the \ref Endpoint_ClearOUT() macro.
+                        *  in both failure and success states; the user is responsible for manually clearing the status OUT packet
+                        *  to finalize the transfer's status stage via the \ref Endpoint_ClearOUT() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -381,7 +381,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.


@@ -403,7 +403,7 @@
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,
                         *  discarding fully read packets from the host as needed. The device IN acknowledgement is not
                         *  automatically sent after success or failure states; the user is responsible for manually sending the

-                        *  setup IN to finalize the transfer via the \ref Endpoint_ClearIN() macro.
+                        *  status IN packet to finalize the transfer's status stage via the \ref Endpoint_ClearIN() macro.

                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.
                         *
                         *  \note This function automatically clears the control transfer's status stage. Do not manually attempt
                         *        to clear the status stage when using this routine in a control transaction.