Skip to content
Snippets Groups Projects
Commit 39fa8337 authored by Dean Camera's avatar Dean Camera
Browse files

Fix Doxygen documentation for conditionally enabled functions.

parent b367949b
Branches
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -216,6 +216,7 @@
const void* const Buffer,
const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
#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
......@@ -231,11 +232,11 @@
*
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
*/
#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
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
#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
......@@ -252,7 +253,6 @@
*
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
*/
#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
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);
......
......@@ -217,6 +217,7 @@
const void* const Buffer,
const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
#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
......@@ -232,11 +233,11 @@
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
*/
#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
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
#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
......@@ -253,7 +254,6 @@
*
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
*/
#if defined(ARCH_HAS_FLASH_ADDRESS_SPACE)
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);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment