From fc92f9969c1fcc2f952f0bd6d09a309a9b3ce02f Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 3 Jun 2010 15:32:45 +0000 Subject: Minor documentation cleanups. --- LUFA/Drivers/USB/Class/Common/MIDI.h | 6 +++--- LUFA/Drivers/USB/Class/Common/MassStorage.h | 2 +- LUFA/Drivers/USB/Class/Common/RNDIS.h | 16 ++++++++-------- 3 files changed, 12 insertions(+), 12 deletions(-) (limited to 'LUFA/Drivers/USB/Class/Common') diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 6910d50f1..3ef523c69 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -82,13 +82,13 @@ /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */ #define MIDI_JACKTYPE_EXTERNAL 0x02 - /** MIDI command for a note on (activation) event */ + /** MIDI command for a note on (activation) event. */ #define MIDI_COMMAND_NOTE_ON 0x90 - /** MIDI command for a note off (deactivation) event */ + /** MIDI command for a note off (deactivation) event. */ #define MIDI_COMMAND_NOTE_OFF 0x80 - /** Standard key press velocity value used for all note events */ + /** Standard key press velocity value used for all note events. */ #define MIDI_STANDARD_VELOCITY 64 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index bc56f2239..78baece6d 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -213,7 +213,7 @@ { uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */ uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */ - uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */ + uint32_t DataTransferLength; /**< Length of the optional data portion of the issued command, in bytes */ uint8_t Flags; /**< Command block flags, indicating command data direction */ uint8_t LUN; /**< Logical Unit number this command is issued to */ uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */ diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index ecbff5122..9424b26a2 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -71,25 +71,25 @@ #endif /* Macros: */ - /** Implemented RNDIS Version Major */ + /** Implemented RNDIS Version Major. */ #define REMOTE_NDIS_VERSION_MAJOR 0x01 - /** Implemented RNDIS Version Minor */ + /** Implemented RNDIS Version Minor. */ #define REMOTE_NDIS_VERSION_MINOR 0x00 - /** RNDIS request to issue a host-to-device NDIS command */ + /** RNDIS request to issue a host-to-device NDIS command. */ #define REQ_SendEncapsulatedCommand 0x00 - /** RNDIS request to issue a device-to-host NDIS response */ + /** RNDIS request to issue a device-to-host NDIS response. */ #define REQ_GetEncapsulatedResponse 0x01 - /** Maximum size in bytes of a RNDIS control message which can be sent or received */ + /** Maximum size in bytes of a RNDIS control message which can be sent or received. */ #define RNDIS_MESSAGE_BUFFER_SIZE 128 - /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard */ + /** Maximum size in bytes of an Ethernet frame according to the Ethernet standard. */ #define ETHERNET_FRAME_SIZE_MAX 1500 - /** Notification request value for a RNDIS Response Available notification */ + /** Notification request value for a RNDIS Response Available notification. */ #define NOTIF_ResponseAvailable 1 /* Enums: */ @@ -101,7 +101,7 @@ RNDIS_Data_Initialized = 2, /**< Adapter currently initialized and ready for data transfers */ }; - /** Enum for the NDIS hardware states */ + /** Enum for the NDIS hardware states. */ enum NDIS_Hardware_Status_t { NDIS_HardwareStatus_Ready, /**< Hardware Ready to accept commands from the host */ -- cgit v1.2.3