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

Doxygen fixes to \param directives to give data direction in all projects. Make HID item filtering routines clearer in the HID WithParser demos.

Browse source
This commit is contained in:
Dean Camera 2009-09-24 02:05:33 +00:00
parent 573a27d90a
commit 409c49f057
12 changed files with 51 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

6
LUFA/Drivers/Board/Dataflash.h
View file

@ -81,9 +81,11 @@
#define __GET_DATAFLASH_MASK(x) __GET_DATAFLASH_MASK2(DATAFLASH_CHIP,x)
#endif
/* Retrieves the Dataflash chip select mask for the given Dataflash chip index.
/** Retrieves the Dataflash chip select mask for the given Dataflash chip index.
*
* \param index Index of the dataflash chip mask to retrieve
* \param[in] index Index of the dataflash chip mask to retrieve
*
* \return Mask for the given Dataflash chip's /CS pin
*/
#define DATAFLASH_CHIP_MASK(index) __GET_DATAFLASH_MASK(index)

2
LUFA/Drivers/USB/Class/Host/HIDParser.h
View file

@ -288,7 +288,7 @@
* HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
* no RAM is wasted storing the attributes for report items which will never be referenced by the application.
*
* \param CurrentItemAttributes Pointer to the current report item attributes for user checking
* \param[in] CurrentItemAttributes Pointer to the current report item attributes for user checking
*
* \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored
*/

2
LUFA/Drivers/USB/LowLevel/Endpoint.h
View file

@ -334,7 +334,7 @@
/** Sets the direction of the currently selected endpoint.
*
* \param DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.
* \param[in] DirectionMask New endpoint direction, as a ENDPOINT_DIR_* mask.
*/
static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);
#else

2
LUFA/Drivers/USB/LowLevel/Pipe.h
View file

@ -805,7 +805,7 @@
/** Determines if a pipe has been bound to the given device endpoint address. If a pipe which is bound to the given
* endpoint is found, it is automatically selected.
*
* \param EndpointAddress Address of the endpoint within the attached device to check
* \param[in] EndpointAddress Address of the endpoint within the attached device to check
*
* \return Boolean true if a pipe bound to the given endpoint address is found, false otherwise
*/