From bd8046976f4c7e8db349e4d4ff14da5fac13e7db Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 12 Jul 2011 10:11:52 +0000 Subject: [PATCH] Minor documentation fixes. --- LUFA/Drivers/USB/Class/Common/HIDParser.c | 2 +- LUFA/Drivers/USB/Class/Common/HIDParser.h | 16 ++++++++-------- LUFA/ManPages/FutureChanges.txt | 1 - 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/LUFA/Drivers/USB/Class/Common/HIDParser.c b/LUFA/Drivers/USB/Class/Common/HIDParser.c index eb2f14c354..bd0937ba8c 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDParser.c +++ b/LUFA/Drivers/USB/Class/Common/HIDParser.c @@ -189,7 +189,7 @@ uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, CurrCollectionPath->Parent = ParentCollectionPath; } - CurrCollectionPath->Type = ReportItemData; + CurrCollectionPath->Type = ReportItemData; CurrCollectionPath->Usage.Page = CurrStateTable->Attributes.Usage.Page; if (UsageListSize) diff --git a/LUFA/Drivers/USB/Class/Common/HIDParser.h b/LUFA/Drivers/USB/Class/Common/HIDParser.h index e0df87e793..7b9dd9dbab 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Common/HIDParser.h @@ -284,8 +284,8 @@ /** Extracts the given report item's value out of the given HID report and places it into the Value * member of the report item's \ref HID_ReportItem_t structure. * - * When called on a report with an item that exists in that report, this copies the report item's Value - * to it's PreviousValue element for easy checking to see if an item's value has changed before processing + * When called on a report with an item that exists in that report, this copies the report item's \c Value + * to its \c PreviousValue element for easy checking to see if an item's value has changed before processing * a report. If the given item does not exist in the report, the function does not modify the report item's * data. * @@ -297,12 +297,12 @@ bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); - /** Retrieves the given report item's value out of the Value member of the report item's + /** Retrieves the given report item's value out of the \c Value member of the report item's * \ref HID_ReportItem_t structure and places it into the correct position in the HID report * buffer. The report buffer is assumed to have the appropriate bits cleared before calling * this function (i.e., the buffer should be explicitly cleared before report values are added). * - * When called, this copies the report item's Value element to it's PreviousValue element for easy + * When called, this copies the report item's \c Value element to its \c PreviousValue element for easy * checking to see if an item's value has changed before sending a report. * * If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item. @@ -313,14 +313,14 @@ void USB_SetHIDReportItemInfo(uint8_t* ReportData, HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); - /** Retrieves the size of a given HID report in bytes from it's Report ID. + /** Retrieves the size of a given HID report in bytes from its Report ID. * * \param[in] ParserData Pointer to a \ref HID_ReportInfo_t instance containing the parser output. - * \param[in] ReportID Report ID of the report whose size is to be retrieved. - * \param[in] ReportType Type of the report whose size is to be determined, a valued from the + * \param[in] ReportID Report ID of the report whose size is to be determined. + * \param[in] ReportType Type of the report whose size is to be determined, a value from the * \ref HID_ReportItemTypes_t enum. * - * \return Size of the report in bytes, or 0 if the report does not exist. + * \return Size of the report in bytes, or \c 0 if the report does not exist. */ uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID, diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt index 8f7e98cedd..51656ac00f 100644 --- a/LUFA/ManPages/FutureChanges.txt +++ b/LUFA/ManPages/FutureChanges.txt @@ -24,7 +24,6 @@ * -# Abstract out Mass Storage byte send/receive to prevent low level API use in projects * -# Consider switch from endpoint numbers to full endpoint addresses to ease future architecture expansion * -# Fix HID report parser usage support for array types - * -# Mass Storage Host demo incompatibilities with some devices * -# Add additional standard request helper functions to host mode * - Documentation/Support * -# Add detailed overviews of how each demo works