From 8f9b5ae00df6654490245d29d1fd703a90be382d Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Wed, 3 Nov 2010 06:50:02 +0000
Subject: [PATCH] Minor documentation improvements.
---
LUFA/Drivers/USB/Class/Common/HID.h | 16 +++++------
LUFA/Drivers/USB/Class/Host/HIDReportData.h | 32 ++++++++++-----------
2 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h
index f53345fa1..d9824dbd1 100644
--- a/LUFA/Drivers/USB/Class/Common/HID.h
+++ b/LUFA/Drivers/USB/Class/Common/HID.h
@@ -351,19 +351,19 @@
/** Enum for the HID class specific control requests that can be issued by the USB bus host. */
enum HID_ClassRequests_t
{
- HID_REQ_GetReport = 0x01, /**< HID class-specific Request to get the current HID report from the device. */
- HID_REQ_GetIdle = 0x02, /**< HID class-specific Request to get the current device idle count. */
- HID_REQ_SetReport = 0x09, /**< HID class-specific Request to set the current HID report to the device. */
- HID_REQ_SetIdle = 0x0A, /**< HID class-specific Request to set the device's idle count. */
- HID_REQ_GetProtocol = 0x03, /**< HID class-specific Request to get the current HID report protocol mode. */
- HID_REQ_SetProtocol = 0x0B, /**< HID class-specific Request to set the current HID report protocol mode. */
+ HID_REQ_GetReport = 0x01, /**< HID class-specific Request to get the current HID report from the device. */
+ HID_REQ_GetIdle = 0x02, /**< HID class-specific Request to get the current device idle count. */
+ HID_REQ_GetProtocol = 0x03, /**< HID class-specific Request to get the current HID report protocol mode. */
+ HID_REQ_SetReport = 0x09, /**< HID class-specific Request to set the current HID report to the device. */
+ HID_REQ_SetIdle = 0x0A, /**< HID class-specific Request to set the device's idle count. */
+ HID_REQ_SetProtocol = 0x0B, /**< HID class-specific Request to set the current HID report protocol mode. */
};
/** Enum for the HID class specific descriptor types. */
enum HID_DescriptorTypes_t
{
- HID_DTYPE_HID = 0x21, /**< Descriptor header type value, to indicate a HID class HID descriptor. */
- HID_DTYPE_Report = 0x22, /**< Descriptor header type value, to indicate a HID class HID report descriptor. */
+ HID_DTYPE_HID = 0x21, /**< Descriptor header type value, to indicate a HID class HID descriptor. */
+ HID_DTYPE_Report = 0x22, /**< Descriptor header type value, to indicate a HID class HID report descriptor. */
};
/** Enum for the different types of HID reports. */
diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
index f183b4a15..ca96b285c 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDReportData.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h
@@ -48,52 +48,52 @@
/* Public Interface - May be used in end-application: */
/* Macros: */
- /** HID_ReportItem_t.ItemFlags flag for constant data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for constant data. */
#define IOF_CONSTANT (1 << 0)
- /** HID_ReportItem_t.ItemFlags flag for data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for data. */
#define IOF_DATA (0 << 0)
- /** HID_ReportItem_t.ItemFlags flag for variable data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for variable data. */
#define IOF_VARIABLE (1 << 1)
- /** HID_ReportItem_t.ItemFlags flag for array data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for array data. */
#define IOF_ARRAY (0 << 1)
- /** HID_ReportItem_t.ItemFlags flag for relative data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for relative data. */
#define IOF_RELATIVE (1 << 2)
- /** HID_ReportItem_t.ItemFlags flag for absolute data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for absolute data. */
#define IOF_ABSOLUTE (0 << 2)
- /** HID_ReportItem_t.ItemFlags flag for wrapped value data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for wrapped value data. */
#define IOF_WRAP (1 << 3)
- /** HID_ReportItem_t.ItemFlags flag for non-wrapped value data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for non-wrapped value data. */
#define IOF_NOWRAP (0 << 3)
- /** HID_ReportItem_t.ItemFlags flag for non linear data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for non linear data. */
#define IOF_NONLINEAR (1 << 4)
- /** HID_ReportItem_t.ItemFlags flag for linear data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for linear data. */
#define IOF_LINEAR (0 << 4)
- /** HID_ReportItem_t.ItemFlags flag for no preferred state. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for no preferred state. */
#define IOF_NOPREFERRED (1 << 5)
- /** HID_ReportItem_t.ItemFlags flag for preferred state items. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for preferred state items. */
#define IOF_PREFERREDSTATE (0 << 5)
- /** HID_ReportItem_t.ItemFlags flag for null state items. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for null state items. */
#define IOF_NULLSTATE (1 << 6)
- /** HID_ReportItem_t.ItemFlags flag for no null position data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for no null position data. */
#define IOF_NONULLPOSITION (0 << 6)
- /** HID_ReportItem_t.ItemFlags flag for buffered bytes. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for buffered bytes. */
#define IOF_BUFFEREDBYTES (1 << 8)
- /** HID_ReportItem_t.ItemFlags flag for bit field data. */
+ /** \ref HID_ReportItem_t.ItemFlags flag for bit field data. */
#define IOF_BITFIELD (0 << 8)
/* Private Interface - For use in library only: */
--
GitLab