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

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

View file

@ -251,20 +251,15 @@ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8
* we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
* have occupied).
*
* \param CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
* \param[in] CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
*
* \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
{
/* Check the attributes of the current item - see if we are interested in it or not */
if (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
{
/* Only store KEYBOARD usage page items into the Processed HID Report structure to save RAM */
return true;
}
else
{
return false;
}
/* Check the attributes of the current item - see if we are interested in it or not;
* only store KEYBOARD usage page items into the Processed HID Report structure to
* save RAM and ignore the rest
*/
return (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
}