michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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