aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/CodeTemplates
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2012-04-08 18:46:56 +0000
committerDean Camera <dean@fourwalledcubicle.com>2012-04-08 18:46:56 +0000
commit3008f8ce131ca6c1f326aa57795b4ab2f411b865 (patch)
tree721be13d61fb3cf833592240da313d57782fe301 /LUFA/CodeTemplates
parent512b4d87cc57f843f2924bd7b7a9fa51c5c2a89c (diff)
downloadlufa-3008f8ce131ca6c1f326aa57795b4ab2f411b865.tar.gz
lufa-3008f8ce131ca6c1f326aa57795b4ab2f411b865.tar.bz2
lufa-3008f8ce131ca6c1f326aa57795b4ab2f411b865.zip
Doxygen documentation style changes. Minor documentation corrections.
Diffstat (limited to 'LUFA/CodeTemplates')
-rw-r--r--LUFA/CodeTemplates/DriverStubs/Buttons.h22
-rw-r--r--LUFA/CodeTemplates/DriverStubs/Dataflash.h20
-rw-r--r--LUFA/CodeTemplates/DriverStubs/Joystick.h20
-rw-r--r--LUFA/CodeTemplates/DriverStubs/LEDs.h20
-rw-r--r--LUFA/CodeTemplates/LUFAConfig.h24
5 files changed, 58 insertions, 48 deletions
diff --git a/LUFA/CodeTemplates/DriverStubs/Buttons.h b/LUFA/CodeTemplates/DriverStubs/Buttons.h
index e050d75af..66f5e1661 100644
--- a/LUFA/CodeTemplates/DriverStubs/Buttons.h
+++ b/LUFA/CodeTemplates/DriverStubs/Buttons.h
@@ -28,16 +28,18 @@
this software.
*/
-/*
- This is a stub driver header file, for implementing custom board
- layout hardware with compatible LUFA board specific drivers. If
- the library is configured to use the BOARD_USER board mode, this
- driver file should be completed and copied into the "/Board/" folder
- inside the application's folder.
-
- This stub is for the board-specific component of the LUFA Buttons driver,
- for the control of physical board-mounted GPIO pushbuttons.
-*/
+/** \file
+ * \brief LUFA Custom Board Button Hardware Driver (Template)
+ *
+ * This is a stub driver header file, for implementing custom board
+ * layout hardware with compatible LUFA board specific drivers. If
+ * the library is configured to use the BOARD_USER board mode, this
+ * driver file should be completed and copied into the "/Board/" folder
+ * inside the application's folder.
+ *
+ * This stub is for the board-specific component of the LUFA Buttons driver,
+ * for the control of physical board-mounted GPIO pushbuttons.
+ */
#ifndef __BUTTONS_USER_H__
#define __BUTTONS_USER_H__
diff --git a/LUFA/CodeTemplates/DriverStubs/Dataflash.h b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
index 9fcc25f9b..02a7acf59 100644
--- a/LUFA/CodeTemplates/DriverStubs/Dataflash.h
+++ b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
@@ -28,15 +28,17 @@
this software.
*/
-/*
- This is a stub driver header file, for implementing custom board
- layout hardware with compatible LUFA board specific drivers. If
- the library is configured to use the BOARD_USER board mode, this
- driver file should be completed and copied into the "/Board/" folder
- inside the application's folder.
-
- This stub is for the board-specific component of the LUFA Dataflash
- driver.
+/** \file
+ * \brief LUFA Custom Board Dataflash Hardware Driver (Template)
+ *
+ * This is a stub driver header file, for implementing custom board
+ * layout hardware with compatible LUFA board specific drivers. If
+ * the library is configured to use the BOARD_USER board mode, this
+ * driver file should be completed and copied into the "/Board/" folder
+ * inside the application's folder.
+ *
+ * This stub is for the board-specific component of the LUFA Dataflash
+ * driver.
*/
#ifndef __DATAFLASH_USER_H__
diff --git a/LUFA/CodeTemplates/DriverStubs/Joystick.h b/LUFA/CodeTemplates/DriverStubs/Joystick.h
index 4843ce6f8..64270f2f1 100644
--- a/LUFA/CodeTemplates/DriverStubs/Joystick.h
+++ b/LUFA/CodeTemplates/DriverStubs/Joystick.h
@@ -28,15 +28,17 @@
this software.
*/
-/*
- This is a stub driver header file, for implementing custom board
- layout hardware with compatible LUFA board specific drivers. If
- the library is configured to use the BOARD_USER board mode, this
- driver file should be completed and copied into the "/Board/" folder
- inside the application's folder.
-
- This stub is for the board-specific component of the LUFA Joystick
- driver, for a digital four-way (plus button) joystick.
+/** \file
+ * \brief LUFA Custom Board Joystick Hardware Driver (Template)
+ *
+ * This is a stub driver header file, for implementing custom board
+ * layout hardware with compatible LUFA board specific drivers. If
+ * the library is configured to use the BOARD_USER board mode, this
+ * driver file should be completed and copied into the "/Board/" folder
+ * inside the application's folder.
+ *
+ * This stub is for the board-specific component of the LUFA Joystick
+ * driver, for a digital four-way (plus button) joystick.
*/
#ifndef __JOYSTICK_USER_H__
diff --git a/LUFA/CodeTemplates/DriverStubs/LEDs.h b/LUFA/CodeTemplates/DriverStubs/LEDs.h
index 1314e9424..7309cf494 100644
--- a/LUFA/CodeTemplates/DriverStubs/LEDs.h
+++ b/LUFA/CodeTemplates/DriverStubs/LEDs.h
@@ -28,15 +28,17 @@
this software.
*/
-/*
- This is a stub driver header file, for implementing custom board
- layout hardware with compatible LUFA board specific drivers. If
- the library is configured to use the BOARD_USER board mode, this
- driver file should be completed and copied into the "/Board/" folder
- inside the application's folder.
-
- This stub is for the board-specific component of the LUFA LEDs driver,
- for the LEDs (up to four) mounted on most development boards.
+/** \file
+ * \brief LUFA Custom Board LED Hardware Driver (Template)
+ *
+ * This is a stub driver header file, for implementing custom board
+ * layout hardware with compatible LUFA board specific drivers. If
+ * the library is configured to use the BOARD_USER board mode, this
+ * driver file should be completed and copied into the "/Board/" folder
+ * inside the application's folder.
+ *
+ * This stub is for the board-specific component of the LUFA LEDs driver,
+ * for the LEDs (up to four) mounted on most development boards.
*/
#ifndef __LEDS_USER_H__
diff --git a/LUFA/CodeTemplates/LUFAConfig.h b/LUFA/CodeTemplates/LUFAConfig.h
index 5672d0e8c..f7d1509cf 100644
--- a/LUFA/CodeTemplates/LUFAConfig.h
+++ b/LUFA/CodeTemplates/LUFAConfig.h
@@ -28,17 +28,19 @@
this software.
*/
-/*
- This is a header file which can be used to configure LUFA's
- compile time options, as an alternative to the compile time
- constants supplied through a makefile. To use this configuration
- header, copy this into your project's root directory and supply
- the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is
- defined in all compiled source files.
-
- For information on what each token does, refer to the LUFA
- manual section "Summary of Compile Tokens".
-*/
+/** \file
+ * \brief LUFA Library Configuration Header File (Template)
+ *
+ * This is a header file which can be used to configure LUFA's
+ * compile time options, as an alternative to the compile time
+ * constants supplied through a makefile. To use this configuration
+ * header, copy this into your project's root directory and supply
+ * the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is
+ * defined in all compiled source files.
+ *
+ * For information on what each token does, refer to the LUFA
+ * manual section "Summary of Compile Tokens".
+ */
#ifndef __LUFA_CONFIG_H__
#define __LUFA_CONFIG_H__