ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation improvements.

Browse source
This commit is contained in:
Dean Camera 2012-02-01 21:28:25 +00:00
parent 956f9e3709
commit fc4d3ab400
20 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

4
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.c
View file

@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
break;
}
if (Pipe_IsError() == true)
if (Pipe_IsError())
{
Pipe_ClearError();
ErrorCode = HOST_WAITERROR_PipeError;
@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
break;
}
if (Pipe_IsStalled() == true)
if (Pipe_IsStalled())
{
Pipe_ClearStall();
ErrorCode = HOST_WAITERROR_SetupStalled;

2
LUFA/Drivers/USB/Core/HostStandardReq.h
View file

@ -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
* 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.
*

8
LUFA/Drivers/USB/Core/StdDescriptors.h
View file

@ -431,8 +431,8 @@
uint8_t ConfigurationNumber; /**< Configuration index of the current configuration. */
uint8_t ConfigurationStrIndex; /**< Index of a string descriptor describing the configuration. */
uint8_t ConfigAttributes; /**< Configuration attributes, comprised of a mask of zero or
* more USB_CONFIG_ATTR_* masks.
uint8_t ConfigAttributes; /**< Configuration attributes, comprised of a mask of \c USB_CONFIG_ATTR_* masks.
* On all devices, this should include USB_CONFIG_ATTR_RESERVED at a minimum.
*/
uint8_t MaxPowerConsumption; /**< Maximum power consumption of the device while in the
@ -462,8 +462,8 @@
uint8_t bNumInterfaces; /**< Total number of interfaces in the configuration. */
uint8_t bConfigurationValue; /**< Configuration index of the current configuration. */
uint8_t iConfiguration; /**< Index of a string descriptor describing the configuration. */
uint8_t bmAttributes; /**< Configuration attributes, comprised of a mask of zero or
* more USB_CONFIG_ATTR_* masks.
uint8_t bmAttributes; /**< Configuration attributes, comprised of a mask of \c USB_CONFIG_ATTR_* masks.
* On all devices, this should include USB_CONFIG_ATTR_RESERVED at a minimum.
*/
uint8_t bMaxPower; /**< Maximum power consumption of the device while in the
* current configuration, calculated by the \ref USB_CONFIG_POWER_MA()

6
LUFA/Drivers/USB/Core/StdRequestType.h
View file

@ -68,14 +68,14 @@
/** Mask for the request type parameter, to indicate the direction of the request data (Host to Device
* or Device to Host). The result of this mask should then be compared to the request direction masks.
*
* \see REQDIR_* macros for masks indicating the request data direction.
* \see \c REQDIR_* macros for masks indicating the request data direction.
*/
#define CONTROL_REQTYPE_DIRECTION 0x80
/** Mask for the request type parameter, to indicate the type of request (Device, Class or Vendor
* Specific). The result of this mask should then be compared to the request type masks.
*
* \see REQTYPE_* macros for masks indicating the request type.
* \see \c REQTYPE_* macros for masks indicating the request type.
*/
#define CONTROL_REQTYPE_TYPE 0x60
@ -83,7 +83,7 @@
* Endpoint or Other). The result of this mask should then be compared to the request recipient
* masks.
*
* \see REQREC_* macros for masks indicating the request recipient.
* \see \c REQREC_* macros for masks indicating the request recipient.
*/
#define CONTROL_REQTYPE_RECIPIENT 0x1F

4
LUFA/Drivers/USB/Core/UC3/Host_UC3.c
View file

@ -219,7 +219,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
break;
}
if (Pipe_IsError() == true)
if (Pipe_IsError())
{
Pipe_ClearError();
ErrorCode = HOST_WAITERROR_PipeError;
@ -227,7 +227,7 @@ uint8_t USB_Host_WaitMS(uint8_t MS)
break;
}
if (Pipe_IsStalled() == true)
if (Pipe_IsStalled())
{
Pipe_ClearStall();
ErrorCode = HOST_WAITERROR_SetupStalled;