X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/2073b96d82433607bd287e3b6529fd0d3cc428cd..0019fbd1294ccc9ecb0ac4ddb5d8c71efcf9597f:/LUFA/Drivers/Board/Buttons.h diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index e112683a8..1e31059d4 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] 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 software and its documentation for any purpose is hereby granted @@ -37,10 +37,10 @@ * User code should include this file, which will in turn include the correct Button driver header file for the * currently selected board. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/Buttons.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Buttons.h file in the user project * directory. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. */ /** \ingroup Group_BoardDrivers @@ -50,17 +50,20 @@ * The following files must be built with any user project that uses this module: * - None * - * \section Module Description + * \section Sec_ModDescription Module Description * Hardware buttons driver. This provides an easy to use driver for the hardware buttons present on many boards. * It provides a way to easily configure and check the status of all the buttons on the board so that appropriate * actions can be taken. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/Dataflash.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Dataflash.h file in the user project * directory. Otherwise, it will include the appropriate built in board driver header file. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. + * + * \section Sec_ExampleUsage Example Usage + * The following snippet is an example of how this module may be used within a typical + * application. * - * Example Usage: * \code * // Initialise the button driver before first use * Buttons_Init();