From 6d53cdba8367a6f589302f913a58d55650f45d97 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 3 Jun 2010 15:55:28 +0000 Subject: More documentation fixes. --- LUFA/Drivers/USB/Class/Common/MassStorage.h | 4 ++-- LUFA/Drivers/USB/Class/Common/Printer.h | 2 +- LUFA/Drivers/USB/Class/Device/Audio.h | 24 ++++++++++++------------ LUFA/Drivers/USB/Class/Host/MassStorage.h | 2 +- LUFA/Drivers/USB/LowLevel/Device.h | 2 +- 5 files changed, 17 insertions(+), 17 deletions(-) (limited to 'LUFA/Drivers/USB') diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 78baece6d..9d656d662 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -235,7 +235,7 @@ /** \brief Mass Storage Class SCSI Sense Structure * * Type define for a SCSI Sense structure. Structures of this type are filled out by the - * device via the MassStore_RequestSense() function, indicating the current sense data of the + * device via the \ref MS_Host_RequestSense() function, indicating the current sense data of the * device (giving explicit error codes for the last issued command). For details of the * structure contents, refer to the SCSI specifications. */ @@ -263,7 +263,7 @@ /** \brief Mass Storage Class SCSI Inquiry Structure. * * Type define for a SCSI Inquiry structure. Structures of this type are filled out by the - * device via the MassStore_Inquiry() function, retrieving the attached device's information. + * device via the \ref MS_Host_Inquiry() function, retrieving the attached device's information. * For details of the structure contents, refer to the SCSI specifications. */ typedef struct diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index 87cf67695..7e89b41be 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -37,7 +37,7 @@ * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. */ -/** \ingroup Group_USBClassMS +/** \ingroup Group_USBClassPrinter * @defgroup Group_USBClassPrinterCommon Common Class Definitions * * \section Module Description diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 45e267923..3586c33e8 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -181,8 +181,8 @@ /** Reads the next 8-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure + * ensure the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * @@ -205,8 +205,8 @@ /** Reads the next 16-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure + * that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * @@ -229,8 +229,8 @@ /** Reads the next 24-bit audio sample from the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure + * that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * @@ -253,8 +253,8 @@ /** Writes the next 8-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to + * ensure that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in] Sample Signed 8-bit audio sample @@ -272,8 +272,8 @@ /** Writes the next 16-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to + * ensure that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in] Sample Signed 16-bit audio sample @@ -291,8 +291,8 @@ /** Writes the next 24-bit audio sample to the current audio interface. * - * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that - * the correct endpoint is selected and ready for data. + * \note This should be preceded immediately by a call to the \ref Audio_Device_IsReadyForNextSample() function to + * ensure that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state * \param[in] Sample Signed 24-bit audio sample diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index b5a085782..7f3894360 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -113,7 +113,7 @@ * * SCSI capacity structure, to hold the total capacity of the device in both the number * of blocks in the current LUN, and the size of each block. This structure is filled by - * the device when the MassStore_ReadCapacity() function is called. + * the device when the \ref MS_Host_ReadCapacity() function is called. */ typedef struct { diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h index 7f9d540bf..cc2af15c0 100644 --- a/LUFA/Drivers/USB/LowLevel/Device.h +++ b/LUFA/Drivers/USB/LowLevel/Device.h @@ -81,7 +81,7 @@ #define USB_DEVICE_OPT_LOWSPEED (1 << 0) #endif - /** Mask for the Options parameter of the USB_Init() function. This indicates that the + /** Mask for the Options parameter of the \ref USB_Init() function. This indicates that the * USB interface should be initialized in full speed (12Mb/s) mode. */ #define USB_DEVICE_OPT_FULLSPEED (0 << 0) -- cgit v1.2.3