More documentation fixes.

diff --git a/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h b/Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h
index 4453bbf..90a4e1c 100644 (file)
--- 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
 
                                                                   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
 
                #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. */
                #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 344e426..f7e957a 100644 (file)
--- 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
 
                                                                   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
 
                #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. */
                #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 b4b6158..17e8796 100644 (file)
--- 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
 
                                                                   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
 
                #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. */
                #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 3b5b3ad..16ea94b 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
+++ b/Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
@@ -42,7 +42,7 @@
                #include "BluetoothHost.h"
 
        /* Enums: */
                #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 */
                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 fdde1e4..06bbc85 100644 (file)
--- a/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
+++ b/Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
@@ -52,6 +52,7 @@
                #define BLUETOOTH_DEVICE_PROTOCOL        0x01
 
        /* Enums: */
                #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 */
                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 3e25cd8..b284b7b 100644 (file)
--- a/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h
@@ -46,7 +46,7 @@
                #define HID_CLASS                   0x03
        
        /* Enums: */
                #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 */
                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 d7badb8..4b059dc 100644 (file)
--- a/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h
@@ -55,7 +55,7 @@
                #define DTYPE_Report                0x22
        
        /* Enums: */
                #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 */
                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 2e6c6f6..3ffc051 100644 (file)
--- a/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
+++ b/Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
@@ -59,7 +59,7 @@
                #define USAGE_Y                     0x31
 
        /* Enums: */
                #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 */
                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 295e073..d319097 100644 (file)
--- a/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h
@@ -49,7 +49,7 @@
                #define KEYBOARD_PROTOCOL              0x01
        
        /* Enums: */
                #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 */
                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 d050934..5a6953b 100644 (file)
--- a/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h
@@ -55,7 +55,7 @@
                #define DTYPE_Report                   0x22
        
        /* Enums: */
                #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 */
                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 b405e09..428b91a 100644 (file)
--- a/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h
+++ b/Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h
@@ -47,7 +47,7 @@
                #define USAGE_PAGE_KEYBOARD             0x07
 
        /* Enums: */
                #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 */
                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 af6d866..4948b58 100644 (file)
--- a/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h
@@ -52,7 +52,7 @@
                #define MIDI_STREAMING_PROTOCOL        0x00
        
        /* Enums: */
                #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 */
                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 d5a5cd9..fa24019 100644 (file)
--- a/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h
@@ -52,7 +52,7 @@
                #define MASS_STORE_PROTOCOL            0x50
 
        /* Enums: */
                #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 */
                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 baa36da..aa34994 100644 (file)
--- 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
                } 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.
                 */
                 *  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
                } 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
                 *  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
                
                /** 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
                {
                 */
                typedef struct
                {

diff --git a/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h b/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h
index 1e7c203..77ea6f2 100644 (file)
--- a/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h
@@ -49,7 +49,7 @@
                #define MOUSE_PROTOCOL              0x02
        
        /* Enums: */
                #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 */
                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 d659e57..4b34ae6 100644 (file)
--- a/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h
@@ -55,7 +55,7 @@
                #define DTYPE_Report                0x22
        
        /* Enums: */
                #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 */
                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 50b62e0..684c743 100644 (file)
--- a/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h
+++ b/Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h
@@ -62,7 +62,7 @@
                #define USAGE_SCROLL_WHEEL          0x38
                
        /* Enums: */
                #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 */
                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 fdb9682..1b66348 100644 (file)
--- a/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h
@@ -48,7 +48,7 @@
                #define PRINTER_PROTOCOL                 0x02
 
        /* Enums: */
                #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 */
                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 149d81b..0f8c992 100644 (file)
--- a/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
@@ -61,7 +61,7 @@
                #define CDC_DATA_PROTOCOL              0x00
        
        /* Enums: */
                #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 */
                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 66f9bfe..631352d 100644 (file)
--- a/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h
@@ -52,7 +52,7 @@
                #define SIMAGE_PROTOCOL                0x01
        
        /* Enums: */
                #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 */
                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 8eae0e3..a6720f2 100644 (file)
--- a/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h
+++ b/Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h
@@ -61,7 +61,7 @@
                #define CDC_DATA_PROTOCOL              0x00
        
        /* Enums: */
                #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 */
                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 78baece..9d656d6 100644 (file)
--- 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
                /** \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.
                 */
                 *  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
                /** \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
                 *  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 87cf676..7e89b41 100644 (file)
--- 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.
  */
 
  *        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
  *  @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 45e2679..3586c33 100644 (file)
--- 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.
                         *
 
                        /** 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
                         *
                         *
                         *  \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.
                         *
 
                        /** 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
                         *
                         *
                         *  \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.
                         *
 
                        /** 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
                         *
                         *
                         *  \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.
                         *
 
                        /** 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
                         *
                         *  \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.
                         *
 
                        /** 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
                         *
                         *  \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.
                         *
 
                        /** 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
                         *
                         *  \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 b5a0857..7f38943 100644 (file)
--- 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
                         *
                         *  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
                        {
                         */
                        typedef struct
                        {

diff --git a/LUFA/Drivers/USB/LowLevel/Device.h b/LUFA/Drivers/USB/LowLevel/Device.h
index 7f9d540..cc2af15 100644 (file)
--- 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
                        
                                #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)
                         *  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 8eeed95..1e15e59 100644 (file)
--- 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
 
                                                                   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
 
                #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. */
                #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 69983fe..4df31f1 100644 (file)
--- a/Projects/MissileLauncher/ConfigDescriptor.h
+++ b/Projects/MissileLauncher/ConfigDescriptor.h
@@ -46,7 +46,7 @@
                #define HID_CLASS                 0x03
 
        /* Enums: */
                #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 */
                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 914ca7b..fd73918 100644 (file)
--- a/Projects/TemperatureDataLogger/Lib/SCSI.h
+++ b/Projects/TemperatureDataLogger/Lib/SCSI.h
@@ -60,10 +60,10 @@
                                                                   SenseData.AdditionalSenseCode = (acode);      \
                                                                   SenseData.AdditionalSenseQualifier = (aqual); }MACROE
 
                                                                   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
 
                #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. */
                #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 e83f59b..d0c485b 100644 (file)
--- a/Projects/Webserver/Lib/SCSI.h
+++ b/Projects/Webserver/Lib/SCSI.h
@@ -59,10 +59,10 @@
                                                                   SenseData.AdditionalSenseCode = (acode);      \
                                                                   SenseData.AdditionalSenseQualifier = (aqual); }MACROE
 
                                                                   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
 
                #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. */
                #define DATA_WRITE          false
 
                /** Value for the DeviceType entry in the SCSI_Inquiry_Response_t enum, indicating a Block Media device. */