Minor documentation improvements.

[pub/USBasp.git] / LUFA / Drivers / USB / Core / HostStandardReq.h

diff --git a/LUFA/Drivers/USB/Core/HostStandardReq.h b/LUFA/Drivers/USB/Core/HostStandardReq.h
index 7b456c7..bd67bcb 100644 (file)
--- a/LUFA/Drivers/USB/Core/HostStandardReq.h
+++ b/LUFA/Drivers/USB/Core/HostStandardReq.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2014.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -69,7 +69,7 @@
                                 */
                                #define USB_HOST_TIMEOUT_MS                1000
                        #endif
                                 */
                                #define USB_HOST_TIMEOUT_MS                1000
                        #endif

-                       
+

                /* Enums: */
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
                         *  if the transfer of the request is unsuccessful.
                /* Enums: */
                        /** Enum for the \ref USB_Host_SendControlRequest() return code, indicating the reason for the error
                         *  if the transfer of the request is unsuccessful.


@@ -91,17 +91,17 @@
 
                /* Global Variables: */
                        /** Indicates the currently set configuration number of the attached device. This indicates the currently
 
                /* Global Variables: */
                        /** Indicates the currently set configuration number of the attached device. This indicates the currently

-                        *  selected configuration value if one has been set sucessfully, or 0 if no configuration has been selected.
+                        *  selected configuration value if one has been set successfully, or 0 if no configuration has been selected.

                         *
                         *  To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
                         *
                         *
                         *  To set a device configuration, call the \ref USB_Host_SetDeviceConfiguration() function.
                         *

-                        *  \note This variable should be treated as read-only in the user application, and never manually
-                        *        changed in value.
+                        *  \attention This variable should be treated as read-only in the user application, and never manually
+                        *             changed in value.

                         *
                         *  \ingroup Group_Host
                         */
                        extern uint8_t USB_Host_ConfigurationNumber;
                         *
                         *  \ingroup Group_Host
                         */
                        extern uint8_t USB_Host_ConfigurationNumber;

-                       
+

                /* Function Prototypes: */
                        /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer
                /* Function Prototypes: */
                        /** Sends the request stored in the \ref USB_ControlRequest global structure to the attached device,
                         *  and transfers the data stored in the buffer to the device, or from the device to the buffer


@@ -130,7 +130,7 @@
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         */
                        uint8_t USB_Host_SetDeviceConfiguration(const uint8_t ConfigNumber);

-                       
+

                        /** Sends a GET CONFIGURATION standard request to the attached device, to retrieve the currently selected
                         *  device configuration index.
                         *
                        /** Sends a GET CONFIGURATION standard request to the attached device, to retrieve the currently selected
                         *  device configuration index.
                         *


@@ -165,7 +165,7 @@
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various
 
                        /** Retrieves the current feature status of the attached device, via a GET STATUS standard request. The
                         *  retrieved feature status can then be examined by masking the retrieved value with the various

-                        *  FEATURE_* masks for bus/self power information and remote wakeup support.
+                        *  \c FEATURE_* masks for bus/self power information and remote wakeup support.

                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *


@@ -239,7 +239,7 @@
                        {
                                return USB_Host_GetDescriptor(DTYPE_Device, 0, DeviceDescriptorPtr, sizeof(USB_Descriptor_Device_t));
                        }
                        {
                                return USB_Host_GetDescriptor(DTYPE_Device, 0, DeviceDescriptorPtr, sizeof(USB_Descriptor_Device_t));
                        }

-                       
+

                        /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
                         *  of the specified index. This can be used to easily retrieve string descriptors from the device by
                         *  index, after the index is obtained from the Device or Configuration descriptors. This is a convenience
                        /** Sends a GET DESCRIPTOR standard request to the attached device, requesting the string descriptor
                         *  of the specified index. This can be used to easily retrieve string descriptors from the device by
                         *  index, after the index is obtained from the Device or Configuration descriptors. This is a convenience


@@ -278,6 +278,7 @@
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HOSTSTDREQ_C)

+                               static uint8_t USB_Host_SendControlRequest_PRV(void* const BufferPtr);

                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
                        #endif
        #endif
                                static uint8_t USB_Host_WaitForIOS(const uint8_t WaitType);
                        #endif
        #endif