From 6d53cdba8367a6f589302f913a58d55650f45d97 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 3 Jun 2010 15:55:28 +0000 Subject: [PATCH] More documentation fixes. --- .../Device/ClassDriver/MassStorage/Lib/SCSI.h | 4 ++-- .../MassStorageKeyboard/Lib/SCSI.h | 4 ++-- Demos/Device/LowLevel/MassStorage/Lib/SCSI.h | 4 ++-- .../BluetoothHost/ConfigDescriptor.h | 2 +- .../BluetoothHost/DeviceDescriptor.h | 1 + .../GenericHIDHost/ConfigDescriptor.h | 2 +- .../JoystickHostWithParser/ConfigDescriptor.h | 2 +- .../JoystickHostWithParser/HIDReport.h | 2 +- .../LowLevel/KeyboardHost/ConfigDescriptor.h | 2 +- .../KeyboardHostWithParser/ConfigDescriptor.h | 2 +- .../KeyboardHostWithParser/HIDReport.h | 2 +- .../Host/LowLevel/MIDIHost/ConfigDescriptor.h | 2 +- .../MassStorageHost/ConfigDescriptor.h | 2 +- .../MassStorageHost/Lib/MassStoreCommands.h | 6 ++--- .../LowLevel/MouseHost/ConfigDescriptor.h | 2 +- .../MouseHostWithParser/ConfigDescriptor.h | 2 +- .../LowLevel/MouseHostWithParser/HIDReport.h | 2 +- .../LowLevel/PrinterHost/ConfigDescriptor.h | 2 +- .../RNDISEthernetHost/ConfigDescriptor.h | 2 +- .../StillImageHost/ConfigDescriptor.h | 2 +- .../VirtualSerialHost/ConfigDescriptor.h | 2 +- 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 +- .../StandaloneProgrammer/Lib/SCSI.h | 4 ++-- Projects/MissileLauncher/ConfigDescriptor.h | 2 +- Projects/TemperatureDataLogger/Lib/SCSI.h | 4 ++-- Projects/Webserver/Lib/SCSI.h | 4 ++-- 30 files changed, 50 insertions(+), 49 deletions(-) diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h index 4453bbf3e2..90a4e1cd75 100644 --- a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h +++ b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h @@ -60,10 +60,10 @@ SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseQualifier = (aqual); }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ diff --git a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.h index 344e426802..f7e957ab75 100644 --- a/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.h +++ b/Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.h @@ -61,10 +61,10 @@ SenseData.AdditionalSenseCode = acode; \ SenseData.AdditionalSenseQualifier = aqual; }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ diff --git a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h index b4b61580e5..17e8796bcd 100644 --- a/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h +++ b/Demos/Device/LowLevel/MassStorage/Lib/SCSI.h @@ -62,10 +62,10 @@ SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseQualifier = (aqual); }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ diff --git a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h index 3b5b3adff7..16ea94b7a2 100644 --- a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h +++ b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h @@ -42,7 +42,7 @@ #include "BluetoothHost.h" /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum BluetoothHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h index fdde1e4318..06bbc85261 100644 --- a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h +++ b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h @@ -52,6 +52,7 @@ #define BLUETOOTH_DEVICE_PROTOCOL 0x01 /* Enums: */ + /** Enum for the possible return codes of the \ref ProcessDeviceDescriptor() function. */ enum BluetoothHost_GetDeviceDescriptorDataCodes_t { SuccessfulDeviceRead = 0, /**< Device Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h b/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h index 3e25cd8f93..b284b7bd88 100644 --- a/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h @@ -46,7 +46,7 @@ #define HID_CLASS 0x03 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum GenericHIDHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h b/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h index d7badb821b..4b059dcad9 100644 --- a/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h @@ -55,7 +55,7 @@ #define DTYPE_Report 0x22 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum JoystickHostWithParser_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h index 2e6c6f6a73..3ffc051e84 100644 --- a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h +++ b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h @@ -59,7 +59,7 @@ #define USAGE_Y 0x31 /* Enums: */ - /** Enum for the possible return codes of the GetHIDReportData() function. */ + /** Enum for the possible return codes of the \ref GetHIDReportData() function. */ enum JoystickHostWithParser_GetHIDReportDataCodes_t { ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ diff --git a/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h b/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h index 295e073412..d319097f38 100644 --- a/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h @@ -49,7 +49,7 @@ #define KEYBOARD_PROTOCOL 0x01 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum KeyboardHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h b/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h index d0509349ce..5a6953b12f 100644 --- a/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h @@ -55,7 +55,7 @@ #define DTYPE_Report 0x22 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h index b405e09b1e..428b91a2b1 100644 --- a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h +++ b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h @@ -47,7 +47,7 @@ #define USAGE_PAGE_KEYBOARD 0x07 /* Enums: */ - /** Enum for the possible return codes of the GetHIDReportData() function. */ + /** Enum for the possible return codes of the \ref GetHIDReportData() function. */ enum KeyboardHostWithParser_GetHIDReportDataCodes_t { ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ diff --git a/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h b/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h index af6d866e59..4948b58647 100644 --- a/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h @@ -52,7 +52,7 @@ #define MIDI_STREAMING_PROTOCOL 0x00 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum MIDIHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h b/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h index d5a5cd9b1c..fa24019ade 100644 --- a/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h @@ -52,7 +52,7 @@ #define MASS_STORE_PROTOCOL 0x50 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum MassStorageHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h index baa36dabc8..aa349946c6 100644 --- a/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h +++ b/Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h @@ -102,7 +102,7 @@ } CommandStatusWrapper_t; /** 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 MassStore_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. */ @@ -128,7 +128,7 @@ } SCSI_Request_Sense_Response_t; /** 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 MassStore_Inquiry() function, retrieving the attached device's information. * For details of the structure contents, refer to the SCSI specifications. */ typedef struct @@ -166,7 +166,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 MassStore_ReadCapacity() function is called. */ typedef struct { diff --git a/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h b/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h index 1e7c203aaa..77ea6f2a3a 100644 --- a/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h @@ -49,7 +49,7 @@ #define MOUSE_PROTOCOL 0x02 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum MouseHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h index d659e577d5..4b34ae6833 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h @@ -55,7 +55,7 @@ #define DTYPE_Report 0x22 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum MouseHostWithParser_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h index 50b62e009c..684c74319e 100644 --- a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h +++ b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h @@ -62,7 +62,7 @@ #define USAGE_SCROLL_WHEEL 0x38 /* Enums: */ - /** Enum for the possible return codes of the GetHIDReportData() function. */ + /** Enum for the possible return codes of the \ref GetHIDReportData() function. */ enum MouseHostWithParser_GetHIDReportDataCodes_t { ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ diff --git a/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h b/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h index fdb9682c3f..1b66348b91 100644 --- a/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h @@ -48,7 +48,7 @@ #define PRINTER_PROTOCOL 0x02 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum PrinterHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h index 149d81bf7a..0f8c992478 100644 --- a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h @@ -61,7 +61,7 @@ #define CDC_DATA_PROTOCOL 0x00 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum RNDISHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h b/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h index 66f9bfead1..631352d4f9 100644 --- a/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h @@ -52,7 +52,7 @@ #define SIMAGE_PROTOCOL 0x01 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum StillImageHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h b/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h index 8eae0e3fe2..a6720f2cdf 100644 --- a/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h +++ b/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h @@ -61,7 +61,7 @@ #define CDC_DATA_PROTOCOL 0x00 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum CDCHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 78baece6d1..9d656d6620 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 87cf676952..7e89b41be6 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 45e2679234..3586c33e89 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 b5a0857822..7f38943601 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 7f9d540bfa..cc2af15c00 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) diff --git a/Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.h b/Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.h index 8eeed95edd..1e15e591ba 100644 --- a/Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.h +++ b/Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.h @@ -59,10 +59,10 @@ SenseData.AdditionalSenseCode = acode; \ SenseData.AdditionalSenseQualifier = aqual; }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ diff --git a/Projects/MissileLauncher/ConfigDescriptor.h b/Projects/MissileLauncher/ConfigDescriptor.h index 69983fed88..4df31f1f9d 100644 --- a/Projects/MissileLauncher/ConfigDescriptor.h +++ b/Projects/MissileLauncher/ConfigDescriptor.h @@ -46,7 +46,7 @@ #define HID_CLASS 0x03 /* Enums: */ - /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */ + /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */ enum GenericHIDHost_GetConfigDescriptorDataCodes_t { SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ diff --git a/Projects/TemperatureDataLogger/Lib/SCSI.h b/Projects/TemperatureDataLogger/Lib/SCSI.h index 914ca7b61b..fd739182eb 100644 --- a/Projects/TemperatureDataLogger/Lib/SCSI.h +++ b/Projects/TemperatureDataLogger/Lib/SCSI.h @@ -60,10 +60,10 @@ SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseQualifier = (aqual); }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ diff --git a/Projects/Webserver/Lib/SCSI.h b/Projects/Webserver/Lib/SCSI.h index e83f59bfcf..d0c485bd93 100644 --- a/Projects/Webserver/Lib/SCSI.h +++ b/Projects/Webserver/Lib/SCSI.h @@ -59,10 +59,10 @@ SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseQualifier = (aqual); }MACROE - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be read from the storage medium. */ #define DATA_READ true - /** Macro for the SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ + /** Macro for the \ref SCSI_Command_ReadWrite_10() function, to indicate that data is to be written to the storage medium. */ #define DATA_WRITE false /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */