aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Class/Host
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-02-24 20:25:36 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-02-24 20:25:36 +0000
commite406140f119281a945c281d25e9a1041b862d592 (patch)
treed8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/USB/Class/Host
parent5561524a8fe7baaeaac3421c9e1d3347186fdf95 (diff)
downloadlufa-e406140f119281a945c281d25e9a1041b862d592.tar.gz
lufa-e406140f119281a945c281d25e9a1041b862d592.tar.bz2
lufa-e406140f119281a945c281d25e9a1041b862d592.zip
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Host')
-rw-r--r--LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h2
-rw-r--r--LUFA/Drivers/USB/Class/Host/CDCClassHost.h2
-rw-r--r--LUFA/Drivers/USB/Class/Host/HIDClassHost.h13
3 files changed, 8 insertions, 9 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h b/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h
index 58bd98fe8..0ec44e715 100644
--- a/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/AndroidAccessoryClassHost.h
@@ -263,7 +263,7 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering.
*
- * \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
+ * \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
* to the given AOA interface.
* \n\n
*
diff --git a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
index 0beb5b1da..5a8df2414 100644
--- a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
@@ -289,7 +289,7 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering.
*
- * \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
+ * \note The created stream can be given as \c stdout if desired to direct the standard output from all \c <stdio.h> functions
* to the given CDC interface.
* \n\n
*
diff --git a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
index 2e88679f2..7bdaad18b 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDClassHost.h
@@ -148,8 +148,8 @@
* device. This should be called once after the stack has enumerated the attached device, while the host state
* machine is in the Addressed state.
*
- * \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
- * to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
+ * \attention Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
+ * to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
* \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor.
@@ -167,8 +167,8 @@
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
* call will fail.
*
- * \note The destination buffer should be large enough to accommodate the largest report that the attached device
- * can generate.
+ * \attention The destination buffer should be large enough to accommodate the largest report that the attached device
+ * can generate.
*
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state.
* \param[in] Buffer Buffer to store the received report into.
@@ -267,9 +267,8 @@
/** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves
* and parses the device's HID report descriptor, so that the size of each report can be determined in advance.
*
- * \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
- * Report Parser this function references <b>must</b> be implemented in the user code.
- * \n\n
+ * \attention Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID
+ * Report Parser this function references <b>must</b> be implemented in the user code.
*
* \note When the \c HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
*