diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-04 04:55:10 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-04 04:55:10 +0000 |
| commit | 87b2572ae50d20f04dfa6bfbd9e0b8b20ee650e9 (patch) | |
| tree | 9d20e638e48568341a6efb977a66a5c27d726d33 /Demos/Host/LowLevel/MouseHostWithParser | |
| parent | f93f73210892cec94a6ca446776879dee64484ed (diff) | |
| download | lufa-87b2572ae50d20f04dfa6bfbd9e0b8b20ee650e9.tar.gz lufa-87b2572ae50d20f04dfa6bfbd9e0b8b20ee650e9.tar.bz2 lufa-87b2572ae50d20f04dfa6bfbd9e0b8b20ee650e9.zip | |
Added new JoystickHostWithParser demos to the library.
Add some missing documentation to some of the library demos.
Diffstat (limited to 'Demos/Host/LowLevel/MouseHostWithParser')
4 files changed, 11 insertions, 6 deletions
diff --git a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.c b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.c index 4a71e9c69..6347fd841 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.c +++ b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.c @@ -43,7 +43,7 @@ *
* This routine searches for a HID interface descriptor containing at least one Interrupt type IN endpoint and HID descriptor.
*
- * \return An error code from the MouseHostWithParser_GetConfigDescriptorDataCodes_t enum.
+ * \return An error code from the \ref MouseHostWithParser_GetConfigDescriptorDataCodes_t enum.
*/
uint8_t ProcessConfigurationDescriptor(void)
{
@@ -108,7 +108,7 @@ uint8_t ProcessConfigurationDescriptor(void) *
* This comparator searches for the next Interface descriptor of the correct Mouse HID Class and Protocol values.
*
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ * \return A value from the \ref DSEARCH_Return_ErrorCodes_t enum
*/
uint8_t DComp_NextMouseInterface(void* CurrentDescriptor)
{
@@ -132,7 +132,7 @@ uint8_t DComp_NextMouseInterface(void* CurrentDescriptor) * This comparator searches for the next IN Endpoint descriptor inside the current interface descriptor,
* aborting the search if another interface descriptor is found before the required endpoint.
*
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ * \return A value from the \ref DSEARCH_Return_ErrorCodes_t enum
*/
uint8_t DComp_NextMouseInterfaceDataEndpoint(void* CurrentDescriptor)
{
@@ -155,7 +155,7 @@ uint8_t DComp_NextMouseInterfaceDataEndpoint(void* CurrentDescriptor) *
* This comparator searches for the next HID descriptor within the current HID interface descriptor.
*
- * \return A value from the DSEARCH_Return_ErrorCodes_t enum
+ * \return A value from the \ref DSEARCH_Return_ErrorCodes_t enum
*/
uint8_t DComp_NextHID(void* CurrentDescriptor)
{
diff --git a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h index 147feafe3..7b33c7428 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h @@ -59,7 +59,7 @@ /* Enums: */
/** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
- enum CDCHost_GetConfigDescriptorDataCodes_t
+ enum MouseHostWithParser_GetConfigDescriptorDataCodes_t
{
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
ControlError = 1, /**< A control request to the device failed to complete successfully */
diff --git a/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf b/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf index 62dc94ca0..26e6f750d 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf +++ b/Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "LUFA Library - Mouse Host (Using Mouse Descriptor Parser)"
+PROJECT_NAME = "LUFA Library - Mouse Host (Using HID Descriptor Parser)"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
diff --git a/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h b/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h index c5bfce52f..92782cf75 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h +++ b/Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h @@ -28,6 +28,11 @@ this software.
*/
+/** \file
+ *
+ * Header file for MouseHostWithParser.c.
+ */
+
#ifndef _MOUSE_HOST_H_
#define _MOUSE_HOST_H_
|