diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-09-24 02:05:33 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-09-24 02:05:33 +0000 |
| commit | 409c49f057f2d1cdea1fc2856ac20771bc0089d1 (patch) | |
| tree | 0cb81f8792dd602749e841d2aca49e38336353a7 /LUFA | |
| parent | 573a27d90ad2f00bfd2c639d3018e65d29099071 (diff) | |
| download | lufa-409c49f057f2d1cdea1fc2856ac20771bc0089d1.tar.gz lufa-409c49f057f2d1cdea1fc2856ac20771bc0089d1.tar.bz2 lufa-409c49f057f2d1cdea1fc2856ac20771bc0089d1.zip | |
Doxygen fixes to \param directives to give data direction in all projects. Make HID item filtering routines clearer in the HID WithParser demos.
Diffstat (limited to 'LUFA')
| -rw-r--r-- | LUFA/Drivers/Board/Dataflash.h | 6 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Host/HIDParser.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Endpoint.h | 2 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/LowLevel/Pipe.h | 2 |
4 files changed, 7 insertions, 5 deletions
diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index 1b9b71f3c..63aca2dc1 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -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)
diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 4322c5106..e9716f3fc 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -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
*/
diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h index 2fa20dfe7..ffeeb7fc4 100644 --- a/LUFA/Drivers/USB/LowLevel/Endpoint.h +++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h @@ -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
diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h index 25ca94b82..39e95cc24 100644 --- a/LUFA/Drivers/USB/LowLevel/Pipe.h +++ b/LUFA/Drivers/USB/LowLevel/Pipe.h @@ -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
*/
|