Fix Doxygen documentation errors.
authorDean Camera <dean@fourwalledcubicle.com>
Tue, 14 Jun 2011 12:55:32 +0000 (12:55 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Tue, 14 Jun 2011 12:55:32 +0000 (12:55 +0000)
Demos/Device/ClassDriver/AudioInput/AudioInput.c
Demos/Device/ClassDriver/AudioOutput/AudioOutput.c
Demos/Device/LowLevel/RNDISEthernet/Lib/RNDIS.c
Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.c
Demos/Host/LowLevel/AudioInputHost/ConfigDescriptor.h
Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.c
Demos/Host/LowLevel/AudioOutputHost/ConfigDescriptor.h

index 4bf1ef8..063977f 100644 (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]     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
index a1125d6..bdb0932 100644 (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]     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
index 1c01177..a56b347 100644 (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. */
 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. */
index 8f55114..0ce054f 100644 (file)
@@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress     = 0;
  *\r
  *  This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.\r
  *\r
- *  \return An error code from the \ref RNDISHost_GetConfigDescriptorDataCodes_t enum.\r
+ *  \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.\r
  */\r
 uint8_t ProcessConfigurationDescriptor(void)\r
 {\r
index 4a1cf90..c2a845e 100644 (file)
@@ -47,7 +47,7 @@
 \r
        /* Enums: */\r
                /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */\r
-               enum KeyboardHost_GetConfigDescriptorDataCodes_t\r
+               enum AudioHost_GetConfigDescriptorDataCodes_t\r
                {\r
                        SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */\r
                        ControlError                    = 1, /**< A control request to the device failed to complete successfully */\r
index 2171320..46a0e33 100644 (file)
@@ -53,7 +53,7 @@ uint8_t StreamingEndpointAddress     = 0;
  *\r
  *  This routine searches for a Streaming Audio interface descriptor containing a valid Isochronous audio endpoint.\r
  *\r
- *  \return An error code from the \ref RNDISHost_GetConfigDescriptorDataCodes_t enum.\r
+ *  \return An error code from the \ref AudioHost_GetConfigDescriptorDataCodes_t enum.\r
  */\r
 uint8_t ProcessConfigurationDescriptor(void)\r
 {\r
index c952a28..08dc69a 100644 (file)
@@ -47,7 +47,7 @@
 \r
        /* Enums: */\r
                /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */\r
-               enum KeyboardHost_GetConfigDescriptorDataCodes_t\r
+               enum AudioHost_GetConfigDescriptorDataCodes_t\r
                {\r
                        SuccessfulConfigRead            = 0, /**< Configuration Descriptor was processed successfully */\r
                        ControlError                    = 1, /**< A control request to the device failed to complete successfully */\r