Commit 6d53cdba authored by Dean Camera's avatar Dean Camera
Browse files

More documentation fixes.

parent fc92f996
...@@ -60,10 +60,10 @@ ...@@ -60,10 +60,10 @@
SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseCode = (acode); \
SenseData.AdditionalSenseQualifier = (aqual); }MACROE 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 #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 #define DATA_WRITE false
/** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
......
...@@ -61,10 +61,10 @@ ...@@ -61,10 +61,10 @@
SenseData.AdditionalSenseCode = acode; \ SenseData.AdditionalSenseCode = acode; \
SenseData.AdditionalSenseQualifier = aqual; }MACROE 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 #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 #define DATA_WRITE false
/** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
......
...@@ -62,10 +62,10 @@ ...@@ -62,10 +62,10 @@
SenseData.AdditionalSenseCode = (acode); \ SenseData.AdditionalSenseCode = (acode); \
SenseData.AdditionalSenseQualifier = (aqual); }MACROE 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 #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 #define DATA_WRITE false
/** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */ /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
#include "BluetoothHost.h" #include "BluetoothHost.h"
/* Enums: */ /* 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 enum BluetoothHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -52,6 +52,7 @@ ...@@ -52,6 +52,7 @@
#define BLUETOOTH_DEVICE_PROTOCOL 0x01 #define BLUETOOTH_DEVICE_PROTOCOL 0x01
/* Enums: */ /* Enums: */
/** Enum for the possible return codes of the \ref ProcessDeviceDescriptor() function. */
enum BluetoothHost_GetDeviceDescriptorDataCodes_t enum BluetoothHost_GetDeviceDescriptorDataCodes_t
{ {
SuccessfulDeviceRead = 0, /**< Device Descriptor was processed successfully */ SuccessfulDeviceRead = 0, /**< Device Descriptor was processed successfully */
......
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
#define HID_CLASS 0x03 #define HID_CLASS 0x03
/* Enums: */ /* 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 enum GenericHIDHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
#define DTYPE_Report 0x22 #define DTYPE_Report 0x22
/* Enums: */ /* 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 enum JoystickHostWithParser_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -59,7 +59,7 @@ ...@@ -59,7 +59,7 @@
#define USAGE_Y 0x31 #define USAGE_Y 0x31
/* Enums: */ /* 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 enum JoystickHostWithParser_GetHIDReportDataCodes_t
{ {
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
......
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
#define KEYBOARD_PROTOCOL 0x01 #define KEYBOARD_PROTOCOL 0x01
/* Enums: */ /* 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 enum KeyboardHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
#define DTYPE_Report 0x22 #define DTYPE_Report 0x22
/* Enums: */ /* 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 enum KeyboardHostWithParser_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -47,7 +47,7 @@ ...@@ -47,7 +47,7 @@
#define USAGE_PAGE_KEYBOARD 0x07 #define USAGE_PAGE_KEYBOARD 0x07
/* Enums: */ /* 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 enum KeyboardHostWithParser_GetHIDReportDataCodes_t
{ {
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
......
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#define MIDI_STREAMING_PROTOCOL 0x00 #define MIDI_STREAMING_PROTOCOL 0x00
/* Enums: */ /* 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 enum MIDIHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#define MASS_STORE_PROTOCOL 0x50 #define MASS_STORE_PROTOCOL 0x50
/* Enums: */ /* 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 enum MassStorageHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -102,7 +102,7 @@ ...@@ -102,7 +102,7 @@
} CommandStatusWrapper_t; } CommandStatusWrapper_t;
/** Type define for a SCSI Sense structure. Structures of this type are filled out by the /** 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 * device (giving explicit error codes for the last issued command). For details of the
* structure contents, refer to the SCSI specifications. * structure contents, refer to the SCSI specifications.
*/ */
...@@ -128,7 +128,7 @@ ...@@ -128,7 +128,7 @@
} SCSI_Request_Sense_Response_t; } SCSI_Request_Sense_Response_t;
/** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the /** 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. * For details of the structure contents, refer to the SCSI specifications.
*/ */
typedef struct typedef struct
...@@ -166,7 +166,7 @@ ...@@ -166,7 +166,7 @@
/** SCSI capacity structure, to hold the total capacity of the device in both the number /** 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 * 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 typedef struct
{ {
......
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
#define MOUSE_PROTOCOL 0x02 #define MOUSE_PROTOCOL 0x02
/* Enums: */ /* 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 enum MouseHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -55,7 +55,7 @@ ...@@ -55,7 +55,7 @@
#define DTYPE_Report 0x22 #define DTYPE_Report 0x22
/* Enums: */ /* 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 enum MouseHostWithParser_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -62,7 +62,7 @@ ...@@ -62,7 +62,7 @@
#define USAGE_SCROLL_WHEEL 0x38 #define USAGE_SCROLL_WHEEL 0x38
/* Enums: */ /* 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 enum MouseHostWithParser_GetHIDReportDataCodes_t
{ {
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */ ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
......
...@@ -48,7 +48,7 @@ ...@@ -48,7 +48,7 @@
#define PRINTER_PROTOCOL 0x02 #define PRINTER_PROTOCOL 0x02
/* Enums: */ /* 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 enum PrinterHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -61,7 +61,7 @@ ...@@ -61,7 +61,7 @@
#define CDC_DATA_PROTOCOL 0x00 #define CDC_DATA_PROTOCOL 0x00
/* Enums: */ /* 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 enum RNDISHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
#define SIMAGE_PROTOCOL 0x01 #define SIMAGE_PROTOCOL 0x01
/* Enums: */ /* 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 enum StillImageHost_GetConfigDescriptorDataCodes_t
{ {
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */ SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment