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

1 files changed, 6 insertions, 11 deletions

diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
index 2623878d1..78ed985a0 100644
--- a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
+++ b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
@@ -75,20 +75,15 @@ uint8_t GetHIDReportData(void)
  *  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)

 }