Massive cleanups to the incomplete BluetoothHost demo, to make the HCL layer code...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StreamCallbacks.h

diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
index 441fd1b..228669e 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
+++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
@@ -27,6 +27,16 @@
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r
+\r
+/** \file\r
+ *  \brief USB endpoint/pipe stream callback management.\r
+ *\r
+ *  This file contains definitions for the creation of optional callback routines which can be passed to the\r
+ *  endpoint and/or pipe stream APIs, to abort the transfer currently in progress when a condition is met.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
+ */\r
  \r
 /** \ingroup Group_USB\r
  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks\r
@@ -41,6 +51,11 @@
 #ifndef __STREAMCALLBACK_H__\r
 #define __STREAMCALLBACK_H__\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
+               #endif\r
+               \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream\r