Add file-level brief documentation.

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Pipe.h

diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.h b/LUFA/Drivers/USB/LowLevel/Pipe.h
index c22c5ae..127cea3 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Pipe.h
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.h
@@ -28,6 +28,16 @@
   this software.\r
 */\r
  \r
   this software.\r
 */\r
  \r

+/** \file\r
+ *  \brief USB host pipe management definitions.\r
+ *\r
+ *  This file contains structures, function prototypes and macros related to the management of the device's\r
+ *  data pipes when the library is initialized in USB host mode.\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_PipeManagement Pipe Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_PipeManagement Pipe Management\r
  *\r