X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/dc42c5eb6b663b0b117b5660ba5818186744efd5..28343b1475b999e61c8fe98eb420507a0e6da388:/LUFA/Drivers/USB/Class/Device/Audio.h

diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h
index cbb6d791b..0749d9536 100644
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -361,9 +361,10 @@
 			uint16_t                  LockDelay; /**< Time required to internally lock endpoint's internal clock recovery circuitry */
 		} USB_AudioStreamEndpoint_Spc_t;	
 
-		/** Type define for an Audio Class interface configuration and state structure. This structure should be used for each Audio
-		 *  Class unit within the device, and passed (per-interface) to the Audio Class driver functions so that each Audio interface
-		 *  has seperate state and configuration data and can be controlled seperately.
+		/** Class state structure. An instance of this structure should be made for each Audio interface
+		 *  within the user application, and passed to each of the Audio class driver functions as the
+		 *  AudioInterfaceInfo parameter. The contents of this structure should be set to their correct
+		 *  values when used, or ommitted to force the library to use default values.
 		 */
 		typedef struct
 		{
@@ -389,21 +390,21 @@
 		 *
 		 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 		 */
-		bool     USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
+		bool USB_Audio_ConfigureEndpoints(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
 
 		/** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be
 		 *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 		 *
 		 *  \param AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 		 */
-		void     USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
+		void USB_Audio_ProcessControlPacket(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
 
 		/** General management task for a given Audio class interface, required for the correct operation of the interface. This should
 		 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 		 *
 		 *  \param AudioInterfaceInfo  Pointer to a structure containing an Audio Class configuration and state.
 		 */
-		void     USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
+		void USB_Audio_USBTask(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
 		
 		/** Reads the next 8-bit audio sample from the current audio interface.
 		 *
@@ -412,7 +413,7 @@
 		 *
 		 *  \return  Signed 8-bit audio sample from the audio interface
 		 */
-		int8_t   USB_Audio_ReadSample8(void);
+		int8_t USB_Audio_ReadSample8(void);
 
 		/** Reads the next 16-bit audio sample from the current audio interface.
 		 *
@@ -421,7 +422,7 @@
 		 *
 		 *  \return  Signed 16-bit audio sample from the audio interface
 		 */
-		int16_t  USB_Audio_ReadSample16(void);
+		int16_t USB_Audio_ReadSample16(void);
 
 		/** Reads the next 24-bit audio sample from the current audio interface.
 		 *
@@ -430,7 +431,7 @@
 		 *
 		 *  \return  Signed 24-bit audio sample from the audio interface
 		 */
-		int32_t  USB_Audio_ReadSample24(void);
+		int32_t USB_Audio_ReadSample24(void);
 
 		/** Writes the next 8-bit audio sample to the current audio interface.
 		 *
@@ -439,7 +440,7 @@
 		 *
 		 *  \param Sample  Signed 8-bit audio sample
 		 */
-		void     USB_Audio_WriteSample8(int8_t Sample);
+		void USB_Audio_WriteSample8(int8_t Sample);
 
 		/** Writes the next 16-bit audio sample to the current audio interface.
 		 *
@@ -448,7 +449,7 @@
 		 *
 		 *  \param Sample  Signed 16-bit audio sample
 		 */
-		void     USB_Audio_WriteSample16(int16_t Sample);
+		void USB_Audio_WriteSample16(int16_t Sample);
 
 		/** Writes the next 24-bit audio sample to the current audio interface.
 		 *
@@ -457,7 +458,7 @@
 		 *
 		 *  \param Sample  Signed 24-bit audio sample
 		 */
-		void     USB_Audio_WriteSample24(int32_t Sample);
+		void USB_Audio_WriteSample24(int32_t Sample);
 
 		/** Determines if the given audio interface is ready for a sample to be read from it.
 		 *
@@ -465,7 +466,7 @@
 		 *
 		 *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise
 		 */
-		bool     USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
+		bool USB_Audio_IsSampleReceived(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
 
 		/** Determines if the given audio interface is ready to accept the next sample to be written to it.
 		 *
@@ -473,7 +474,7 @@
 		 *
 		 *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise
 		 */
-		bool     USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
+		bool USB_Audio_IsReadyForNextSample(USB_ClassInfo_Audio_t* AudioInterfaceInfo);
 
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)