diff options
Diffstat (limited to 'Demos')
21 files changed, 26 insertions, 25 deletions
diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h index 4453bbf3e..90a4e1cd7 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 344e42680..f7e957ab7 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 b4b61580e..17e8796bc 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 3b5b3adff..16ea94b7a 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 fdde1e431..06bbc8526 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 3e25cd8f9..b284b7bd8 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 d7badb821..4b059dcad 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 2e6c6f6a7..3ffc051e8 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 295e07341..d319097f3 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 d0509349c..5a6953b12 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 b405e09b1..428b91a2b 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 af6d866e5..4948b5864 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 d5a5cd9b1..fa24019ad 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 baa36dabc..aa349946c 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 1e7c203aa..77ea6f2a3 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 d659e577d..4b34ae683 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 50b62e009..684c74319 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 fdb9682c3..1b66348b9 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 149d81bf7..0f8c99247 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 66f9bfead..631352d4f 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 8eae0e3fe..a6720f2cd 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 */ |