Minor documentation fixes.

[pub/USBasp.git] / LUFA / Drivers / Board / BUMBLEB / Buttons.h

diff --git a/LUFA/Drivers/Board/BUMBLEB/Buttons.h b/LUFA/Drivers/Board/BUMBLEB/Buttons.h
index 4494d92..b4bab86 100644 (file)
--- a/LUFA/Drivers/Board/BUMBLEB/Buttons.h
+++ b/LUFA/Drivers/Board/BUMBLEB/Buttons.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  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
   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
   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
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -29,26 +29,20 @@
 */
 
 /** \file
 */
 
 /** \file

- *  \brief Board specific Buttons driver header for the BUMBLEB.
- *
- *  Board specific Buttons driver header for the BUMBLEB (http://fletchtronics.net/bumble-b).
- *
- *  The BUMBLEB third-party board does not include any on-board peripherals, but does have an officially recommended
- *  external peripheral layout for buttons, LEDs and a Joystick.
+ *  \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB.
+ *  \copydetails Group_Buttons_BUMBLEB

  *
  *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
  *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
  */
 
 /** \ingroup Group_Buttons
  *
  *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
  *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
  */
 
 /** \ingroup Group_Buttons

- *  @defgroup Group_Buttons_BUMBLEB BUMBLEB
+ *  \defgroup Group_Buttons_BUMBLEB BUMBLEB
+ *  \brief Board specific Buttons driver header for the Fletchtronics BUMBLEB.

  *
  *

- *  Board specific buttons driver header for the BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB third-party
- *  board does not include any on-board peripherals, but does have an officially recommended external peripheral layout
- *  for buttons, LEDs and a Joystick.
- *
- *  \note This file should not be included directly. It is automatically included as needed by the Buttons driver
- *        dispatch header located in LUFA/Drivers/Board/Buttons.h.
+ *  Board specific buttons driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
+ *  third-party board does not include any on-board peripherals, but does have an officially recommended external peripheral
+ *  layout for buttons, LEDs and a Joystick.

  *
  *  @{
  */
  *
  *  @{
  */


@@ -57,9 +51,6 @@
 #define __BUTTONS_BUMBLEB_H__
 
        /* Includes: */
 #define __BUTTONS_BUMBLEB_H__
 
        /* Includes: */

-               #include <avr/io.h>
-               #include <stdbool.h>
-

                #include "../../../Common/Common.h"
 
        /* Enable C linkage for C++ Compilers: */
                #include "../../../Common/Common.h"
 
        /* Enable C linkage for C++ Compilers: */


@@ -71,12 +62,12 @@
                #if !defined(__INCLUDE_FROM_BUTTONS_H)
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
                #endif
                #if !defined(__INCLUDE_FROM_BUTTONS_H)
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.
                #endif

-               
+

        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Button mask for the first button on the board. */
                        #define BUTTONS_BUTTON1      (1 << 7)
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Button mask for the first button on the board. */
                        #define BUTTONS_BUTTON1      (1 << 7)

-       
+

                /* Inline Functions: */
                #if !defined(__DOXYGEN__)
                        static inline void Buttons_Init(void)
                /* Inline Functions: */
                #if !defined(__DOXYGEN__)
                        static inline void Buttons_Init(void)


@@ -96,7 +87,8 @@
                #if defined(__cplusplus)
                        }
                #endif
                #if defined(__cplusplus)
                        }
                #endif

-                       
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+