Minor documentation fixes to the completed Host mode Class drivers.

3 files changed, 12 insertions, 6 deletions

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index f3abb296e..4bb16a50b 100644
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -110,13 +110,13 @@
 			

 		/* Enums: */

 			/** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */

-			enum

+			enum CDCHost_EnumerationFailure_ErrorCodes_t

 			{

 				CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */

 				CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */

 				CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */

 				CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */

-			} CDCHost_EnumerationFailure_ErrorCodes_t;

+			};

 	

 		/* Function Prototypes: */

 			/** General management task for a given CDC host class interface, required for the correct operation of the interface. This should

@@ -135,6 +135,8 @@
 			 *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state

 			 *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor

 			 *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor

+			 *

+			 *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum

 			 */

 			uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,

 			                                uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 6e1a5222b..56b27df79 100644
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -95,13 +95,13 @@
 			} USB_ClassInfo_HID_Host_t;

 

 		/* Enums: */

-			enum

+			enum HIDHost_EnumerationFailure_ErrorCodes_t

 			{

 				HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */

 				HID_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */

 				HID_ENUMERROR_NoHIDInterfaceFound        = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor */

 				HID_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible HID endpoints were not found in the device's HID interface */

-			} HIDHost_EnumerationFailure_ErrorCodes_t;

+			};

 	

 		/* Function Prototypes: */

 			void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index e64e143a7..5a057895d 100644
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -164,13 +164,13 @@
 			} SCSI_Capacity_t;

 

 		/* Enums: */

-			enum

+			enum MSHost_EnumerationFailure_ErrorCodes_t

 			{

 				MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */

 				MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */

 				MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */

 				MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */

-			} MSHost_EnumerationFailure_ErrorCodes_t;

+			};

 	

 		/* Function Prototypes: */

 			/** General management task for a given Mass Storage host class interface, required for the correct operation of

@@ -190,6 +190,8 @@
 			 *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state

 			 *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor

 			 *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor

+			 *

+			 *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum

 			 */

 			uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,

 			                               uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);

@@ -276,6 +278,7 @@
 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[in] BlockAddress  Starting block address within the device to read from

 			 *  \param[in] Blocks  Total number of blocks to read

+			 *  \param[in] BlockSize  Size in bytes of each block within the device

 			 *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored

 			 *

 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready

@@ -289,6 +292,7 @@
 			 *  \param[in] LUNIndex  LUN index within the device the command is being issued to

 			 *  \param[in] BlockAddress  Starting block address within the device to write to

 			 *  \param[in] Blocks  Total number of blocks to read

+			 *  \param[in] BlockSize  Size in bytes of each block within the device

 			 *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from

 			 *

 			 *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready