X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/a8b66f318dda3cc18dfcedaa3af3d01ab68b82e8..2e76ad721e494f3a14ece73100ea9a2144c6fe8e:/LUFA/Drivers/USB/Class/Host/StillImage.h

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index 3bbf71000..b79b81747 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] 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,7 +38,7 @@
  */
 
 /** \ingroup Group_USBClassSI
- *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
+ *  \defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
@@ -67,10 +67,6 @@
 			#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
 		#endif
 
-		#if defined(__INCLUDE_FROM_STILLIMAGE_HOST_C) && defined(NO_STREAM_CALLBACKS)
-			#error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
-		#endif
-
 	/* Public Interface - May be used in end-application: */
 		/* Macros: */
 			/** Error code for some Still Image Host functions, indicating a logical (and not hardware) error. */
@@ -80,7 +76,7 @@
 			/** \brief Still Image Class Host Mode Configuration and State Structure.
 			 *
 			 *  Class state structure. An instance of this structure should be made within the user application,
-			 *  and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This
+			 *  and passed to each of the Still Image class driver functions as the \c SIInterfaceInfo parameter. This
 			 *  stores each Still Image interface's configuration and state information.
 			 */
 			typedef struct
@@ -104,7 +100,7 @@
 					                    *   after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the
 					                    *   Configured state.
 					                    */
-					uint8_t  InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */
+					uint8_t  InterfaceNumber; /**< Interface index of the Still Image interface within the attached device. */
 
 					uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */
 					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe. */
@@ -192,7 +188,7 @@
 			                                PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
 			                                ATTR_NON_NULL_PTR_ARG(2);
 
-			/** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with
+			/** Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with
 			 *  or without parameters.
 			 *
 			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
@@ -225,7 +221,7 @@
 			                            const uint8_t TotalParams,
 			                            uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1);
 
-			/** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data
+			/** Receives and checks a response block from the attached Still Image device, once a command has been issued and all data
 			 *  associated with the command has been transferred.
 			 *
 			 *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
@@ -245,7 +241,7 @@
 			 *
 			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state.
 			 *
-			 *  \return Boolean true if an event is waiting to be read, false otherwise.
+			 *  \return Boolean \c true if an event is waiting to be read, \c false otherwise.
 			 */
 			bool SI_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);