X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b37d77eab32d171ad7b28157a924a4026e2aebd1..29ba88cffd4198b02e8ca04c31aed2c175c5502e:/LUFA/Drivers/USB/Class/Common/MIDI.h

diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h
index 22e32479f..d2e884a97 100644
--- a/LUFA/Drivers/USB/Class/Common/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Common/MIDI.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -38,9 +38,9 @@
  */
 
 /** \ingroup Group_USBClassMIDI
- *  @defgroup Group_USBClassMIDICommon  Common Class Definitions
+ *  \defgroup Group_USBClassMIDICommon  Common Class Definitions
  *
- *  \section Module Description
+ *  \section Sec_ModDescription Module Description
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  MIDI Class.
  *
@@ -54,11 +54,9 @@
 		#define __INCLUDE_FROM_AUDIO_DRIVER
 
 	/* Includes: */
-		#include "../../HighLevel/StdDescriptors.h"
+		#include "../../Core/StdDescriptors.h"
 		#include "Audio.h"
 
-		#include <string.h>
-
 	/* Enable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			extern "C" {
@@ -70,11 +68,14 @@
 		#endif
 
 	/* Macros: */
+		/** \name MIDI Command Values */
+		//@{
 		/** MIDI command for a note on (activation) event. */
 		#define MIDI_COMMAND_NOTE_ON        0x90
 
 		/** MIDI command for a note off (deactivation) event. */
 		#define MIDI_COMMAND_NOTE_OFF       0x80
+		//@}
 
 		/** Standard key press velocity value used for all note events. */
 		#define MIDI_STANDARD_VELOCITY      64
@@ -87,6 +88,7 @@
 		#define MIDI_CHANNEL(channel)        ((channel) - 1)
 
 	/* Enums: */
+		/** Enum for the possible MIDI jack types in a MIDI device jack descriptor. */
 		enum MIDI_JackTypes_t
 		{
 			MIDI_JACKTYPE_Embedded = 0x01, /**< MIDI class descriptor jack type value for an embedded (logical) MIDI input or output jack. */
@@ -147,7 +149,7 @@
 			USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 			uint8_t                 Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
-			uint8_t                 JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+			uint8_t                 JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 			uint8_t                 JackID; /**< ID value of this jack - must be a unique value within the device. */
 
 			uint8_t                 JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */
@@ -170,7 +172,7 @@
 
 			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
-			uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+			uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 			uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
 			uint8_t  iJack; /**< Index of a string descriptor describing this descriptor within the device. */
@@ -188,7 +190,7 @@
 			USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
 			uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
-			uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+			uint8_t                   JackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 			uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device. */
 
 			uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical. */
@@ -215,7 +217,7 @@
 
 			uint8_t  bDescriptorSubtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
 
-			uint8_t  bJackType; /**< Type of jack, one of the JACKTYPE_* mask values. */
+			uint8_t  bJackType; /**< Type of jack, one of the \c JACKTYPE_* mask values. */
 			uint8_t  bJackID; /**< ID value of this jack - must be a unique value within the device. */
 
 			uint8_t  bNrInputPins; /**< Number of output channels within the jack, either physical or logical. */