Add file-level brief documentation.

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

diff --git a/LUFA/Drivers/USB/HighLevel/USBMode.h b/LUFA/Drivers/USB/HighLevel/USBMode.h
index 4105bc9..d894bba 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBMode.h
+++ b/LUFA/Drivers/USB/HighLevel/USBMode.h
@@ -28,6 +28,17 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief USB mode and capability macros.\r
+ *\r
+ *  This file defines macros indicating the type of USB controller the library is being compiled for, and its\r
+ *  capabilities. These macros may then be referenced in the user application to selectively enable or disable\r
+ *  code sections depending on if they are defined or not.\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_USBMode USB Mode Tokens\r
  *\r