Update all demos, projects and bootloaders to indent all function parameters, one...

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Host.h

diff --git a/LUFA/Drivers/USB/LowLevel/Host.h b/LUFA/Drivers/USB/LowLevel/Host.h
index 1ef0239..d83431b 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Host.h
+++ b/LUFA/Drivers/USB/LowLevel/Host.h
@@ -134,21 +134,21 @@
                                 *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
                                 *  except for the Remote Wakeup event from the device if supported.
                                 *
                                 *  false otherwise. While suspended, no USB communications can occur until the bus is resumed,
                                 *  except for the Remote Wakeup event from the device if supported.
                                 *

-                                *  \return Boolean true if the bus is currently suspended, false otherwise
+                                *  \return Boolean true if the bus is currently suspended, false otherwise.

                                 */
                                 static inline bool USB_Host_IsBusSuspended(void);
                                 
                                /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
                                 *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
                                 *
                                 */
                                 static inline bool USB_Host_IsBusSuspended(void);
                                 
                                /** Determines if the attached device is currently enumerated in Full Speed mode (12Mb/s), or
                                 *  false if the attached device is enumerated in Low Speed mode (1.5Mb/s).
                                 *

-                                *  \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise
+                                *  \return Boolean true if the attached device is enumerated in Full Speed mode, false otherwise.

                                 */
                                static inline bool USB_Host_IsDeviceFullSpeed(void);
 
                                /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
                                 *  that the host resume the USB bus and wake up the device, false otherwise.
                                 *
                                 */
                                static inline bool USB_Host_IsDeviceFullSpeed(void);
 
                                /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting
                                 *  that the host resume the USB bus and wake up the device, false otherwise.
                                 *

-                                *  \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise
+                                *  \return Boolean true if the attached device has sent a Remote Wakeup request, false otherwise.

                                 */
                                static inline bool USB_Host_IsRemoteWakeupSent(void);
 
                                 */
                                static inline bool USB_Host_IsRemoteWakeupSent(void);
 


@@ -164,7 +164,7 @@
                                /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
                                 *  device.
                                 *
                                /** Determines if a resume from Remote Wakeup request is currently being sent to an attached
                                 *  device.
                                 *

-                                *  \return Boolean true if no resume request is currently being sent, false otherwise
+                                *  \return Boolean true if no resume request is currently being sent, false otherwise.

                                 */
                                static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);
                        #else
                                 */
                                static inline bool USB_Host_IsResumeFromWakeupRequestSent(void);
                        #else


@@ -177,7 +177,7 @@
                                #define USB_Host_SuspendBus()              MACROS{ UHCON &= ~(1 << SOFEN);          }MACROE 
                                
                                #define USB_Host_IsBusSuspended()                ((UHCON &   (1 << SOFEN)) ? false : true)
                                #define USB_Host_SuspendBus()              MACROS{ UHCON &= ~(1 << SOFEN);          }MACROE 
                                
                                #define USB_Host_IsBusSuspended()                ((UHCON &   (1 << SOFEN)) ? false : true)

-                       
+

                                #define USB_Host_IsDeviceFullSpeed()             ((USBSTA &  (1 << SPEED)) ? true : false)
 
                                #define USB_Host_IsRemoteWakeupSent()            ((UHINT &   (1 << RXRSMI)) ? true : false)
                                #define USB_Host_IsDeviceFullSpeed()             ((USBSTA &  (1 << SPEED)) ? true : false)
 
                                #define USB_Host_IsRemoteWakeupSent()            ((UHINT &   (1 << RXRSMI)) ? true : false)


@@ -196,7 +196,7 @@
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *

-                        *  \param[in] ConfigNumber  Configuration index to send to the device
+                        *  \param[in] ConfigNumber  Configuration index to send to the device.

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */


@@ -209,7 +209,7 @@
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *  \param[out] DeviceDescriptorPtr  Pointer to the destination device descriptor structure where

-                        *                                   the read data is to be stored
+                        *                                   the read data is to be stored.

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */


@@ -222,23 +222,25 @@
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *

-                        *  \param[in] Index  Index of the string index to retrieve
-                        *  \param[out] Buffer  Pointer to the destination buffer where the retrieved string decriptor is
-                        *                      to be stored
-                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer
+                        *  \param[in]  Index        Index of the string index to retrieve.
+                        *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string descriptor is
+                        *                           to be stored.
+                        *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer.

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */

-                       uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index, void* const Buffer, const uint8_t BufferLength);
+                       uint8_t USB_Host_GetDeviceStringDescriptor(const uint8_t Index,
+                                                                  void* const Buffer,
+                                                                  const uint8_t BufferLength);

                        
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                        
                        /** Clears a stall condition on the given pipe, via a ClearFeature request to the attached device.
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *

-                        *  \param[in] EndpointIndex  Index of the endpoint to clear
+                        *  \param[in] EndpointIndex  Index of the endpoint to clear.

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.

-                        */                     
+                        */

                        uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);
 
                /* Enums: */
                        uint8_t USB_Host_ClearPipeStall(uint8_t EndpointIndex);
 
                /* Enums: */


@@ -377,7 +379,7 @@
                                                                      */
                                HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
                                                                      *   complete successfully.
                                                                      */
                                HOST_ENUMERROR_ControlError     = 3, /**< One of the enumeration control requests failed to
                                                                      *   complete successfully.

-                                                                                                         */
+                                                                     */

                                HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
                                                                      *   configure correctly.
                                                                      */
                                HOST_ENUMERROR_PipeConfigError  = 4, /**< The default control pipe (address 0) failed to
                                                                      *   configure correctly.
                                                                      */