gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-06-05 16:02:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

More documentation fixes.

Browse Source
This commit is contained in:
Dean Camera 2010-06-03 15:55:28 +00:00
parent fc92f9969c
commit 6d53cdba83
30 changed files with 50 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Demos/Device/ClassDriver/MassStorage/Lib/SCSI.h
View File

@ -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. */

4
Demos/Device/ClassDriver/MassStorageKeyboard/Lib/SCSI.h
View File

@ -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. */

4
Demos/Device/LowLevel/MassStorage/Lib/SCSI.h
View File

@ -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. */

2
Demos/Host/Incomplete/BluetoothHost/ConfigDescriptor.h
View File

@ -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 */

1
Demos/Host/Incomplete/BluetoothHost/DeviceDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/GenericHIDHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/JoystickHostWithParser/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/JoystickHostWithParser/HIDReport.h
View File

@ -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 */

2
Demos/Host/LowLevel/KeyboardHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/KeyboardHostWithParser/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.h
View File

@ -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 */

2
Demos/Host/LowLevel/MIDIHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/MassStorageHost/ConfigDescriptor.h
View File

@ -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 */

6
Demos/Host/LowLevel/MassStorageHost/Lib/MassStoreCommands.h
View File

@ -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
{

2
Demos/Host/LowLevel/MouseHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/MouseHostWithParser/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.h
View File

@ -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 */

2
Demos/Host/LowLevel/PrinterHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/RNDISEthernetHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/StillImageHost/ConfigDescriptor.h
View File

@ -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 */

2
Demos/Host/LowLevel/VirtualSerialHost/ConfigDescriptor.h
View File

@ -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 */

4
LUFA/Drivers/USB/Class/Common/MassStorage.h
View File

@ -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

2
LUFA/Drivers/USB/Class/Common/Printer.h
View File

@ -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

24
LUFA/Drivers/USB/Class/Device/Audio.h
View File

@ -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

2
LUFA/Drivers/USB/Class/Host/MassStorage.h
View File

@ -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
{

2
LUFA/Drivers/USB/LowLevel/Device.h
View File

@ -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)

4
Projects/Incomplete/StandaloneProgrammer/Lib/SCSI.h
View File

@ -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. */

2
Projects/MissileLauncher/ConfigDescriptor.h
View File

@ -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 */

4
Projects/TemperatureDataLogger/Lib/SCSI.h
View File

@ -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. */

4
Projects/Webserver/Lib/SCSI.h
View File

@ -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. */