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 ca26cd9..64270f2 100644 (file)
--- a/LUFA/CodeTemplates/DriverStubs/Joystick.h
+++ b/LUFA/CodeTemplates/DriverStubs/Joystick.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] 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
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -28,24 +28,23 @@
   this software.
 */
 
   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: */
 */
 
 #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: */
                // TODO: Add any required includes here
 
        /* Enable C linkage for C++ Compilers: */


@@ -82,6 +81,11 @@
                                // TODO: Initialize joystick port pins as inputs with pull-ups
                        }
 
                                // 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)
                        {
                        static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t Joystick_GetStatus(void)
                        {