From 57eedebd191c91ce125238a8a2cb1482186d6164 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 14 Jun 2011 12:55:32 +0000 Subject: Fix Doxygen documentation errors. --- Demos/Device/ClassDriver/AudioInput/AudioInput.c | 2 +- Demos/Device/ClassDriver/AudioOutput/AudioOutput.c | 2 +- Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c | 2 +- Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c | 2 +- Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h | 2 +- Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c | 2 +- Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) (limited to 'Demos') diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.c b/Demos/Device/ClassDriver/AudioInput/AudioInput.c index 4bf1ef875..063977f1a 100644 --- a/Demos/Device/ClassDriver/AudioInput/AudioInput.c +++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.c @@ -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] 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,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 diff --git a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c index a1125d62f..bdb09324e 100644 --- a/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c +++ b/Demos/Device/ClassDriver/AudioOutput/AudioOutput.c @@ -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] 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,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 diff --git a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c index 1c0117792..a56b34738 100644 --- a/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c +++ b/Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c @@ -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. */ 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; /** Current Ethernet packet filter mask. This is non-zero when the adapter is initialized, or zero when disabled. */ diff --git a/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c b/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c index 8f551144c..0ce054f34 100644 --- a/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c +++ b/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c @@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress = 0; * * 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) { diff --git a/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h b/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h index 4a1cf9093..c2a845e4d 100644 --- a/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h @@ -47,7 +47,7 @@ /* Enums: */ /** 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 */ ControlError = 1, /**< A control request to the device failed to complete successfully */ diff --git a/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c b/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c index 2171320c7..46a0e331f 100644 --- a/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c +++ b/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c @@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress = 0; * * 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) { diff --git a/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h b/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h index c952a2813..08dc69a5f 100644 --- a/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h @@ -47,7 +47,7 @@ /* Enums: */ /** 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 */ ControlError = 1, /**< A control request to the device failed to complete successfully */ -- cgit v1.2.3