ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added new JoystickHostWithParser demos to the library.

Browse source 
Add some missing documentation to some of the library demos.
This commit is contained in:
Dean Camera 2009-11-04 04:55:10 +00:00
parent f93f732108
commit 87b2572ae5
35 changed files with 5881 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.c
View file

@ -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)
{

2
Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h
View file

@ -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 */

2
Demos/Host/LowLevel/MouseHostWithParser/Doxygen.conf
View file

@ -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

5
Demos/Host/LowLevel/MouseHostWithParser/MouseHostWithParser.h
View file

@ -28,6 +28,11 @@
this software.
*/
/** \file
*
* Header file for MouseHostWithParser.c.
*/
#ifndef _MOUSE_HOST_H_
#define _MOUSE_HOST_H_