diff options
author | Dean Camera <[email protected]> | 2010-06-03 15:55:28 +0000 |
---|---|---|
committer | Dean Camera <[email protected]> | 2010-06-03 15:55:28 +0000 |
commit | 6d53cdba8367a6f589302f913a58d55650f45d97 (patch) | |
tree | 669b1213696f5e9d428196763761bfac19395c6e /Demos/Host/LowLevel | |
parent | fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f (diff) | |
download | qmk_firmware-6d53cdba8367a6f589302f913a58d55650f45d97.tar.gz qmk_firmware-6d53cdba8367a6f589302f913a58d55650f45d97.zip |
More documentation fixes.
Diffstat (limited to 'Demos/Host/LowLevel')
16 files changed, 18 insertions, 18 deletions
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 */ |