From 7dc3d3a68f889efeca5af51b22bd043eff8e0926 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sat, 8 Jan 2011 11:47:20 +0000 Subject: Minor documentation improvements. --- LUFA/Drivers/Board/Buttons.h | 8 ++++---- LUFA/Drivers/Board/Dataflash.h | 14 +++++++------- LUFA/Drivers/Board/Joystick.h | 8 ++++---- LUFA/Drivers/Board/LEDs.h | 10 +++++----- 4 files changed, 20 insertions(+), 20 deletions(-) (limited to 'LUFA/Drivers/Board') diff --git a/LUFA/Drivers/Board/Buttons.h b/LUFA/Drivers/Board/Buttons.h index bcb779bd6..1e31059d4 100644 --- a/LUFA/Drivers/Board/Buttons.h +++ b/LUFA/Drivers/Board/Buttons.h @@ -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 @@ -55,10 +55,10 @@ * 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 diff --git a/LUFA/Drivers/Board/Dataflash.h b/LUFA/Drivers/Board/Dataflash.h index d8da7543e..27be323ef 100644 --- a/LUFA/Drivers/Board/Dataflash.h +++ b/LUFA/Drivers/Board/Dataflash.h @@ -37,10 +37,10 @@ * User code should include this file, which will in turn include the correct dataflash driver header file for * the currently selected board. * - * 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. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. */ /** \ingroup Group_BoardDrivers @@ -54,10 +54,10 @@ * Dataflash driver. This module provides an easy to use interface for the Dataflash ICs located on many boards, * for the storage of large amounts of data into the Dataflash's non-volatile memory. * - * 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 @@ -156,13 +156,13 @@ /** Determines the currently selected dataflash chip. * * \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected - * or a DATAFLASH_CHIPn mask (where n is the chip number). + * or a \c DATAFLASH_CHIPn mask (where n is the chip number). */ static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT; /** Selects the given dataflash chip. * - * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is + * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of \c DATAFLASH_CHIPn mask (where n is * the chip number). */ static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE; @@ -172,7 +172,7 @@ /** Selects a dataflash IC from the given page number, which should range from 0 to * ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one - * dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside + * dataflash IC, this will select \ref DATAFLASH_CHIP1. If the given page number is outside * the total number of pages contained in the boards dataflash ICs, all dataflash ICs * are deselected. * diff --git a/LUFA/Drivers/Board/Joystick.h b/LUFA/Drivers/Board/Joystick.h index cc17bb363..f2298e9bd 100644 --- a/LUFA/Drivers/Board/Joystick.h +++ b/LUFA/Drivers/Board/Joystick.h @@ -37,10 +37,10 @@ * User code should include this file, which will in turn include the correct joystick driver header file for the * currently selected board. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/Joystick.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/Joystick.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 @@ -54,10 +54,10 @@ * Hardware Joystick driver. This module provides an easy to use interface to control the hardware digital Joystick * located on many boards. * - * 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 diff --git a/LUFA/Drivers/Board/LEDs.h b/LUFA/Drivers/Board/LEDs.h index 872b59301..0e2d484c4 100644 --- a/LUFA/Drivers/Board/LEDs.h +++ b/LUFA/Drivers/Board/LEDs.h @@ -37,10 +37,10 @@ * User code should include this file, which will in turn include the correct LED driver header file for the * currently selected board. * - * If the BOARD value is set to BOARD_USER, this will include the /Board/LEDs.h file in the user project + * If the \c BOARD value is set to \c BOARD_USER, this will include the \c /Board/LEDs.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 @@ -54,11 +54,11 @@ * Hardware LEDs driver. This provides an easy to use driver for the hardware LEDs present on many boards. It * provides an interface to configure, test and change the status of all the board LEDs. * - * 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. If the BOARD value - * is set to BOARD_NONE, this driver is silently disabled. + * is set to \c BOARD_NONE, this driver is silently disabled. * - * For possible BOARD makefile values, see \ref Group_BoardTypes. + * For possible \c BOARD makefile values, see \ref Group_BoardTypes. * * \note To make code as compatible as possible, it is assumed that all boards carry a minimum of four LEDs. If * a board contains less than four LEDs, the remaining LED masks are defined to 0 so as to have no effect. -- cgit v1.2.3