diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 13:08:29 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-02-20 13:08:29 +0000 |
| commit | 5e7319058268e021ae39ca4b9fcabaec0060117b (patch) | |
| tree | f40fe1525f2053746540498041f1e8a819277bd7 /LUFA/Drivers/USB/Core/USBMode.h | |
| parent | 1daa5e16f9a395fb2943906a715adb35b8106988 (diff) | |
| download | lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.gz lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.bz2 lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.zip | |
Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
Diffstat (limited to 'LUFA/Drivers/USB/Core/USBMode.h')
| -rw-r--r-- | LUFA/Drivers/USB/Core/USBMode.h | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/LUFA/Drivers/USB/Core/USBMode.h b/LUFA/Drivers/USB/Core/USBMode.h index 58f9927dc..ff95ce3d5 100644 --- a/LUFA/Drivers/USB/Core/USBMode.h +++ b/LUFA/Drivers/USB/Core/USBMode.h @@ -29,11 +29,8 @@ */ /** \file - * \brief USB mode and capability macros. - * - * This file defines macros indicating the type of USB controller the library is being compiled for, and its - * capabilities. These macros may then be referenced in the user application to selectively enable or disable - * code sections depending on if they are defined or not. + * \brief USB mode and feature support definitions. + * \copydetails Group_USBMode * * \note This file should not be included directly. It is automatically included as needed by the USB driver * dispatch header located in LUFA/Drivers/USB/USB.h. @@ -41,11 +38,15 @@ /** \ingroup Group_USB * \defgroup Group_USBMode USB Mode Tokens + * \brief USB mode and feature support definitions. + * + * This file defines macros indicating the type of USB controller the library is being compiled for, and its + * capabilities. These macros may then be referenced in the user application to selectively enable or disable + * code sections depending on if they are defined or not. * - * After the inclusion of the master USB driver header, one or more of the following - * tokens may be defined, to allow the user code to conditionally enable or disable - * code based on the USB controller family and allowable USB modes. These tokens may - * be tested against to eliminate code relating to a USB mode which is not enabled for + * After the inclusion of the master USB driver header, one or more of the following tokens may be defined, to + * allow the user code to conditionally enable or disable code based on the USB controller family and allowable + * USB modes. These tokens may be tested against to eliminate code relating to a USB mode which is not enabled for * the given compilation. * * @{ |