From 39fa8337db0e63e959368bc384adb3abb9e9a4e8 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Fri, 7 Dec 2018 22:54:53 +1100
Subject: [PATCH] Fix Doxygen documentation for conditionally enabled
 functions.

---
 .../USB/Class/Device/CCIDClassDevice.h        |  5 +-
 .../Drivers/USB/Class/Device/CDCClassDevice.h | 62 +++++++++----------
 LUFA/Drivers/USB/Class/Host/CDCClassHost.h    | 62 +++++++++----------
 3 files changed, 65 insertions(+), 64 deletions(-)

diff --git a/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
index e29ccef08..562ad3b5f 100644
--- a/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/CCIDClassDevice.h
@@ -147,8 +147,8 @@
 			 *  Retrieves the current status of a given slot
 			 *
 			 *	\param[in,out] CCIDInterfaceInfo	Pointer to a structure containing a CCID Class configuration and state.
-			 *  \param[in]     slot 				The slot ID from which we want to retrieve the status.
-			 *  \param[out]    error				The result of the operation, or error.
+			 *  \param[in]     Slot 				The slot ID from which we want to retrieve the status.
+			 *  \param[out]    Error				The result of the operation, or error.
 			 *
 			 *  \return	The command result code.
 			 */
@@ -178,6 +178,7 @@
 			 *  \param[in,out] CCIDInterfaceInfo	Pointer to a structure containing a CCID Class configuration, state and protocol data.
 			 *  \param[in]     Slot 				The slot ID from which we want to retrieve the status.
 			 *  \param[out]    Error				The result of the operation, or error.
+			 *  \param[out]    ProtocolNum			The CCID protocol ID of the parameter being retrieved.
 			 *  \param[out]    T0 					Pointer to a buffer where the parameters will be returned
 			 *
 			 *  \return	The command result code.
diff --git a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
index 2e327ef22..69dcff3d6 100644
--- a/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/CDCClassDevice.h
@@ -216,43 +216,43 @@
 			                            const void* const Buffer,
 			                            const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 
-			/** Sends a given null terminated string from PROGMEM space to the attached USB host, if connected. If a host is not connected
-			 *  when the function is called, the string is discarded. Bytes will be queued for transmission to the host until either
-			 *  the endpoint bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to
-			 *  the host. This allows for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
-			 *
-			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
-			 *       the call will fail.
-			 *
-			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
-			 *
-			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
-			 *  \param[in]     String            Pointer to the null terminated string to send to the host.
-			 *
-			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
-			 */
 			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
+				/** Sends a given null terminated string from PROGMEM space to the attached USB host, if connected. If a host is not connected
+				 *  when the function is called, the string is discarded. Bytes will be queued for transmission to the host until either
+				 *  the endpoint bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to
+				 *  the host. This allows for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
+				 *
+				 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
+				 *       the call will fail.
+				 *
+				 *  \note This function does not exist on architectures that do not have a separate flash memory space.
+				 *
+				 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+				 *  \param[in]     String            Pointer to the null terminated string to send to the host.
+				 *
+				 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+				 */
 				uint8_t CDC_Device_SendString_P(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 				                                const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 			#endif
 
-			/** Sends a given data buffer from PROGMEM space to the attached USB host, if connected. If a host is not connected when the
-			 *  function is called, the string is discarded. Bytes will be queued for transmission to the host until either the endpoint
-			 *  bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows
-			 *  for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
-			 *
-			 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
-			 *       the call will fail.
-			 *
-			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
-			 *
-			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
-			 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
-			 *  \param[in]     Length            Length of the data to send to the host.
-			 *
-			 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
-			 */
 			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
+				/** Sends a given data buffer from PROGMEM space to the attached USB host, if connected. If a host is not connected when the
+				 *  function is called, the string is discarded. Bytes will be queued for transmission to the host until either the endpoint
+				 *  bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows
+				 *  for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
+				 *
+				 *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
+				 *       the call will fail.
+				 *
+				 *  \note This function does not exist on architectures that do not have a separate flash memory space.
+				 *
+				 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+				 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
+				 *  \param[in]     Length            Length of the data to send to the host.
+				 *
+				 *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+				 */
 				uint8_t CDC_Device_SendData_P(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
 				                              const void* const Buffer,
 				                              const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
diff --git a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
index 306bf23d1..da557733f 100644
--- a/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
+++ b/LUFA/Drivers/USB/Class/Host/CDCClassHost.h
@@ -217,43 +217,43 @@
 			                          const void* const Buffer,
 			                          const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
 
-			/** Sends a given null terminated string from PROGMEM space to the attached USB device, if connected. If a device is not connected
-			 *  when the function is called, the string is discarded. Bytes will be queued for transmission to the device until either
-			 *  the pipe bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to
-			 *  the device. This allows for multiple bytes to be packed into a single pipe packet, increasing data throughput.
-			 *
-			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
-			 *       the call will fail.
-			 *
-			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
-			 *
-			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
-			 *  \param[in]     String            Pointer to the null terminated string to send to the host.
-			 *
-			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
-			 */
 			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
+				/** Sends a given null terminated string from PROGMEM space to the attached USB device, if connected. If a device is not connected
+				 *  when the function is called, the string is discarded. Bytes will be queued for transmission to the device until either
+				 *  the pipe bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to
+				 *  the device. This allows for multiple bytes to be packed into a single pipe packet, increasing data throughput.
+				 *
+				 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
+				 *       the call will fail.
+				 *
+				 *  \note This function does not exist on architectures that do not have a separate flash memory space.
+				 *
+				 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
+				 *  \param[in]     String            Pointer to the null terminated string to send to the host.
+				 *
+				 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
+				 */
 				uint8_t CDC_Host_SendString_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 			                                  const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 			#endif
 
-			/** Sends a given data buffer from PROGMEM space to the attached USB device, if connected. If a device is not connected when the
-			 *  function is called, the string is discarded. Bytes will be queued for transmission to the host until either the pipe
-			 *  bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
-			 *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
-			 *
-			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
-			 *       the call will fail.
-			 *
-			 *  \note This function does not exist on architectures that do not have a separate flash memory space.
-			 *
-			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
-			 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
-			 *  \param[in]     Length            Length of the data to send to the host.
-			 *
-			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
-			 */
 			#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
+				/** Sends a given data buffer from PROGMEM space to the attached USB device, if connected. If a device is not connected when the
+				 *  function is called, the string is discarded. Bytes will be queued for transmission to the host until either the pipe
+				 *  bank becomes full, or the \ref CDC_Host_Flush() function is called to flush the pending data to the device. This allows
+				 *  for multiple bytes to be packed into a single pipe packet, increasing data throughput.
+				 *
+				 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or
+				 *       the call will fail.
+				 *
+				 *  \note This function does not exist on architectures that do not have a separate flash memory space.
+				 *
+				 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
+				 *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
+				 *  \param[in]     Length            Length of the data to send to the host.
+				 *
+				 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
+				 */
 				uint8_t CDC_Host_SendData_P(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
 			                                const void* const Buffer,
 			                                const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
-- 
GitLab