diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h index 4453bbf3e2eb0393f04506472fe1122819e00045..90a4e1cd75a8f69b7afe2627d0de59baa47583d9 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 344e42680218ef59cb465a188648d8350fddfbf1..f7e957ab75ef9bb8c3208f3581302e22386f59b4 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 b4b61580e5b311b143d01be0b84d0814c5c90fea..17e8796bcda4b9ba9c1ff427ccb92618c6b7d4d9 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 3b5b3adff76c10a1652b7a7d4d5903915f6a085e..16ea94b7a27058b35b4021da9baa047bf5f002c5 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 fdde1e4318077f87ec8db97d88d2f9e79da9bd56..06bbc85261c55be1030a84182b85f17c626891cf 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 3e25cd8f936c2dfea6d35cc05107b8efa8284f8e..b284b7bd889fb6783ec0a8c5885fe558b7a486b1 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 d7badb821b3ffd56dc1f07b0404fb5c2e800c7fb..4b059dcad93064bbac1ee996986f58376855eb77 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 2e6c6f6a731be2a1dd98c0851ed6c50f97dbe49f..3ffc051e84910e3343bfa981d4e4ed5c752dbc6f 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 295e073412e4ab06d8736344fad3903ab63a08d8..d319097f38b91a374e64abcede6d55bf936132c9 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 d0509349ceaae1b053c362ef099710d00eeaabf4..5a6953b12f40969269050d433df5d86918f3db2e 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 b405e09b1e0fd59819eafeeeb315aef0254d739f..428b91a2b156d78ad94cb9d32cb19dd5e8049cf9 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 af6d866e59112d36245d2fb3f4a1764f663b0a94..4948b58647ce41c42969b4eabf186510f447622b 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 d5a5cd9b1c55f3ccd9d7dafbb81b62d407cf7db1..fa24019adeb3744441ec6a7cfafc4fe687036db5 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 baa36dabc88787827a5bc952a922fe53c6469bec..aa349946c60f267c031d31bce36c720f9dc623c8 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 1e7c203aaa6bb7c92977050c15dfabf3668b2b4a..77ea6f2a3ab0c1d2de06e2159d55bf61751f80f6 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 d659e577d58344ba5834d3a79a55e81a753a01e9..4b34ae683326dd00c7e96d60cb1b80ab1002f722 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 50b62e009c595f697e2ed7162a391b01133d418c..684c74319e900789fa7dd8347d85454c8d3d32a7 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 fdb9682c3f087d1a083077b9fa26077a439a8651..1b66348b915a89eecad07086575e0b2b03f282b6 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 149d81bf7ac64f8c40c41446e29feec034783341..0f8c992478d936e79af6bde0324f24067b34fe21 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 66f9bfead1c6ca145983fa93fb6044a6575fabd8..631352d4f941dcf67ea682ee4e0c85fbadcf90f9 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 8eae0e3fe2ca831e8f34e171a941b0c5b12cd822..a6720f2cdfddaaec1c3088929a083c7f2332d808 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 78baece6d1745b039f2dfb4b35ec27457526093b..9d656d6620d296fec3b409fc18e04b1138e505b0 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 87cf676952b8db83023dd9c82ac22350a1902a24..7e89b41be61556b74ef9a84b37116b7aa5fb3c8d 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 45e26792345c89ff887c7d20972161c7e018df2a..3586c33e89f7b94df508d3f9e5b0d82a0812cb1c 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 b5a085782268b2259c973de0ec7663e84b4d286d..7f38943601771802f74e420732b36edee3f03f6f 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 7f9d540bfac0347353304ddee13198af64c4671a..cc2af15c0023735724c50819f9d96ce86a868d42 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 8eeed95edd06cc5acdb3b624c60faf9da330e946..1e15e591ba15eca3c805b5fb580453314c4210c2 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 69983fed88a22410186c2a1731230a79c94acc1a..4df31f1f9dbd8cda66d4fd4e313b19b95a7d9197 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 914ca7b61b57c2c5aa12b12a21c24b54ef739822..fd739182ebca649a18a59002600ccd2f49c80343 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 e83f59bfcffcb7d4ca1eb0abad2a560f7e3cae36..d0c485bd93a23bbd51c84c83b8283e725920f440 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. */