Minor documentation enhancements.

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / ConfigDescriptor.h

diff --git a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
index 14457ca..001653b 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
@@ -51,12 +51,12 @@
 #define __CONFIGDESCRIPTOR_H__
 
        /* Includes: */
 #define __CONFIGDESCRIPTOR_H__
 
        /* Includes: */

-               #include <avr/io.h>
+               #include <stdint.h>

                
                #include "../../../Common/Common.h"
                
                #include "../../../Common/Common.h"

-               #include "../HighLevel/USBMode.h"
-               #include "../LowLevel/HostChapter9.h"
-               #include "../HighLevel/StdDescriptors.h"
+               #include "HostStandardReq.h"
+               #include "USBMode.h"
+               #include "StdDescriptors.h"

                
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)


@@ -218,7 +218,7 @@
                         *  function. The routine updates the position and remaining configuration descriptor bytes values
                         *  automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
                         *  so that the next descriptor search invocation will start from the descriptor which first caused the
                         *  function. The routine updates the position and remaining configuration descriptor bytes values
                         *  automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
                         *  so that the next descriptor search invocation will start from the descriptor which first caused the

-                        *  original search to fail. This behavior allows for one comparator to be used immediately after another
+                        *  original search to fail. This behaviour allows for one comparator to be used immediately after another

                         *  has failed, starting the second search from the descriptor which failed the first.
                         *
                         *  Comparator functions should be standard functions which accept a pointer to the header of the current
                         *  has failed, starting the second search from the descriptor which failed the first.
                         *
                         *  Comparator functions should be standard functions which accept a pointer to the header of the current


@@ -254,7 +254,9 @@
                         *  }
                         *  \endcode
                         */
                         *  }
                         *  \endcode
                         */

-                       uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, void** const CurrConfigLoc, ConfigComparatorPtr_t const ComparatorRoutine);
+                       uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem,
+                                                         void** const CurrConfigLoc,
+                                                         ConfigComparatorPtr_t const ComparatorRoutine);

 
                /* Inline Functions: */
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
 
                /* Inline Functions: */
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then


@@ -263,9 +265,10 @@
                         * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor.
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor.
                         */
                         * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor.
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor.
                         */

-                       static inline void USB_GetNextDescriptor(uint16_t* const BytesRem, void** CurrConfigLoc) 
-                                                                ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);                                                                       
-                       static inline void USB_GetNextDescriptor(uint16_t* const BytesRem, void** CurrConfigLoc)
+                       static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
+                                                                void** CurrConfigLoc) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);                                                                         
+                       static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
+                                                                void** CurrConfigLoc)

                        {
                                uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;
                                
                        {
                                uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;