gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-17 13:12:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix Doxygen documentation errors.

Browse Source
This commit is contained in:
Dean Camera 2011-06-14 12:55:32 +00:00
parent 21a012a018
commit 57eedebd19
7 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Demos/Device/ClassDriver/AudioInput/AudioInput.c
View File

@ -178,7 +178,7 @@ void EVENT_USB_Device_ControlRequest(void)
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
* \param[in] EndpointProperty Property of the endpoint to get or set, a value from Audio_ClassRequests_t. * \param[in] EndpointProperty Property of the endpoint to get or set, a value from Audio_ClassRequests_t.
* \param[in] EndpointIndex Index of the streaming endpoint whose property is being referenced. * \param[in] EndpointAddress Address of the streaming endpoint whose property is being referenced.
* \param[in] EndpointControl Parameter of the endpoint to get or set, a value from Audio_EndpointControls_t. * \param[in] EndpointControl Parameter of the endpoint to get or set, a value from Audio_EndpointControls_t.
* \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum * \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum
* length of the retrieved data. When NULL, the function should return whether the given property * length of the retrieved data. When NULL, the function should return whether the given property

2
Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
View File

@ -215,7 +215,7 @@ void EVENT_USB_Device_ControlRequest(void)
* *
* \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.
* \param[in] EndpointProperty Property of the endpoint to get or set, a value from Audio_ClassRequests_t. * \param[in] EndpointProperty Property of the endpoint to get or set, a value from Audio_ClassRequests_t.
* \param[in] EndpointIndex Index of the streaming endpoint whose property is being referenced. * \param[in] EndpointAddress Address of the streaming endpoint whose property is being referenced.
* \param[in] EndpointControl Parameter of the endpoint to get or set, a value from Audio_EndpointControls_t. * \param[in] EndpointControl Parameter of the endpoint to get or set, a value from Audio_EndpointControls_t.
* \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum * \param[in,out] DataLength For SET operations, the length of the parameter data to set. For GET operations, the maximum
* length of the retrieved data. When NULL, the function should return whether the given property * length of the retrieved data. When NULL, the function should return whether the given property

2
Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
View File

@ -89,7 +89,7 @@ RNDIS_Message_Header_t* MessageHeader = (RNDIS_Message_Header_t*)&RNDISMessageBu
/** Indicates if a RNDIS message response is ready to be sent back to the host. */ /** Indicates if a RNDIS message response is ready to be sent back to the host. */
bool ResponseReady = false; bool ResponseReady = false;
/** Current RNDIS adapter state, a value from the \ref RNDIS_States_t enum. */ /** Current RNDIS adapter state, a value from the \c RNDIS_States_t enum. */
uint8_t CurrRNDISState = RNDIS_Uninitialized; uint8_t CurrRNDISState = RNDIS_Uninitialized;
/** Current Ethernet packet filter mask. This is non-zero when the adapter is initialized, or zero when disabled. */ /** Current Ethernet packet filter mask. This is non-zero when the adapter is initialized, or zero when disabled. */

2
Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c
View File

@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress = 0;
* *
* This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint. * This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.
* *
* \return An error code from the \ref RNDISHost_GetConfigDescriptorDataCodes_t enum. * \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.
*/ */
uint8_t ProcessConfigurationDescriptor(void) uint8_t ProcessConfigurationDescriptor(void)
{ {

2
Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h
View File

@ -47,7 +47,7 @@
/* Enums: */ /* Enums: */
/** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
enum KeyboardHost_GetConfigDescriptorDataCodes_t enum AudioHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
ControlError = 1, /**< A control request to the device failed to complete successfully */ ControlError = 1, /**< A control request to the device failed to complete successfully */

2
Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c
View File

@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress = 0;
* *
* This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint. * This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.
* *
* \return An error code from the \ref RNDISHost_GetConfigDescriptorDataCodes_t enum. * \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.
*/ */
uint8_t ProcessConfigurationDescriptor(void) uint8_t ProcessConfigurationDescriptor(void)
{ {

2
Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h
View File

@ -47,7 +47,7 @@
/* Enums: */ /* Enums: */
/** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
enum KeyboardHost_GetConfigDescriptorDataCodes_t enum AudioHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
ControlError = 1, /**< A control request to the device failed to complete successfully */ ControlError = 1, /**< A control request to the device failed to complete successfully */