Fix broken documentation in the CDC and DFU class bootloaders due to Doxygen's confus...

[pub/USBasp.git] / LUFA / CodeTemplates / DriverStubs / Joystick.h

diff --git a/LUFA/CodeTemplates/DriverStubs/Joystick.h b/LUFA/CodeTemplates/DriverStubs/Joystick.h
index 4e7040a..64270f2 100644 (file)
--- a/LUFA/CodeTemplates/DriverStubs/Joystick.h
+++ b/LUFA/CodeTemplates/DriverStubs/Joystick.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
@@ -28,24 +28,23 @@
   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, a small surface mount four-way (plus button) digital joystick
-   on most USB AVR boards.
+/** \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__
 #define __JOYSTICK_USER_H__
 
        /* Includes: */
-               #include <avr/io.h>
-
                // TODO: Add any required includes here
 
        /* Enable C linkage for C++ Compilers: */
@@ -57,7 +56,7 @@
                #if !defined(__INCLUDE_FROM_JOYSTICK_H)
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
                #endif
-       
+
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Mask for the joystick being pushed in the left direction. */
@@ -74,14 +73,19 @@
 
                        /** Mask for the joystick being pushed inward. */
                        #define JOY_PRESS                 // TODO: Add mask to indicate joystick pressed position here
-                       
+
                /* Inline Functions: */
                #if !defined(__DOXYGEN__)
                        static inline void Joystick_Init(void)
                        {
                                // TODO: Initialize joystick port pins as inputs with pull-ups
                        }
-                       
+
+                       static inline void Joystick_Disable(void)
+                       {
+                               // TODO: Clear the joystick pins as high impedance inputs here
+                       }
+
                        static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t Joystick_GetStatus(void)
                        {
@@ -95,3 +99,4 @@
                #endif
 
 #endif
+