nathan
/
qmk-fw
1
0
Fork 0
Code Issues Releases Activity

Doxygen documentation style changes. Minor documentation corrections.

Browse Source
Dean Camera 13 years ago
parent 512b4d87cc
commit 3008f8ce13
10 changed files with 1150 additions and 53 deletions
Show Stats Download Patch File Download Diff File

2
LUFA.pnproj
View File

File diff suppressed because one or more lines are too long

22
LUFA/CodeTemplates/DriverStubs/Buttons.h
Unescape Escape View File

@ -28,16 +28,18 @@
this software. this software.
*/ */
/* /** \file
This is a stub driver header file, for implementing custom board * \brief LUFA Custom Board Button Hardware Driver (Template)
layout hardware with compatible LUFA board specific drivers. If *
the library is configured to use the BOARD_USER board mode, this * This is a stub driver header file, for implementing custom board
driver file should be completed and copied into the "/Board/" folder * layout hardware with compatible LUFA board specific drivers. If
inside the application's folder. * the library is configured to use the BOARD_USER board mode, this
* driver file should be completed and copied into the "/Board/" folder
This stub is for the board-specific component of the LUFA Buttons driver, * inside the application's folder.
for the control of physical board-mounted GPIO pushbuttons. *
*/ * This stub is for the board-specific component of the LUFA Buttons driver,
* for the control of physical board-mounted GPIO pushbuttons.
*/
#ifndef __BUTTONS_USER_H__ #ifndef __BUTTONS_USER_H__
#define __BUTTONS_USER_H__ #define __BUTTONS_USER_H__

20
LUFA/CodeTemplates/DriverStubs/Dataflash.h
Unescape Escape View File

@ -28,15 +28,17 @@
this software. this software.
*/ */
/* /** \file
This is a stub driver header file, for implementing custom board * \brief LUFA Custom Board Dataflash Hardware Driver (Template)
layout hardware with compatible LUFA board specific drivers. If *
the library is configured to use the BOARD_USER board mode, this * This is a stub driver header file, for implementing custom board
driver file should be completed and copied into the "/Board/" folder * layout hardware with compatible LUFA board specific drivers. If
inside the application's folder. * the library is configured to use the BOARD_USER board mode, this
* driver file should be completed and copied into the "/Board/" folder
This stub is for the board-specific component of the LUFA Dataflash * inside the application's folder.
driver. *
* This stub is for the board-specific component of the LUFA Dataflash
* driver.
*/ */
#ifndef __DATAFLASH_USER_H__ #ifndef __DATAFLASH_USER_H__

20
LUFA/CodeTemplates/DriverStubs/Joystick.h
Unescape Escape View File

@ -28,15 +28,17 @@
this software. this software.
*/ */
/* /** \file
This is a stub driver header file, for implementing custom board * \brief LUFA Custom Board Joystick Hardware Driver (Template)
layout hardware with compatible LUFA board specific drivers. If *
the library is configured to use the BOARD_USER board mode, this * This is a stub driver header file, for implementing custom board
driver file should be completed and copied into the "/Board/" folder * layout hardware with compatible LUFA board specific drivers. If
inside the application's folder. * the library is configured to use the BOARD_USER board mode, this
* driver file should be completed and copied into the "/Board/" folder
This stub is for the board-specific component of the LUFA Joystick * inside the application's folder.
driver, for a digital four-way (plus button) joystick. *
* 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__ #ifndef __JOYSTICK_USER_H__

20
LUFA/CodeTemplates/DriverStubs/LEDs.h
Unescape Escape View File

@ -28,15 +28,17 @@
this software. this software.
*/ */
/* /** \file
This is a stub driver header file, for implementing custom board * \brief LUFA Custom Board LED Hardware Driver (Template)
layout hardware with compatible LUFA board specific drivers. If *
the library is configured to use the BOARD_USER board mode, this * This is a stub driver header file, for implementing custom board
driver file should be completed and copied into the "/Board/" folder * layout hardware with compatible LUFA board specific drivers. If
inside the application's folder. * the library is configured to use the BOARD_USER board mode, this
* driver file should be completed and copied into the "/Board/" folder
This stub is for the board-specific component of the LUFA LEDs driver, * inside the application's folder.
for the LEDs (up to four) mounted on most development boards. *
* This stub is for the board-specific component of the LUFA LEDs driver,
* for the LEDs (up to four) mounted on most development boards.
*/ */
#ifndef __LEDS_USER_H__ #ifndef __LEDS_USER_H__

24
LUFA/CodeTemplates/LUFAConfig.h
Unescape Escape View File

@ -28,17 +28,19 @@
this software. this software.
*/ */
/* /** \file
This is a header file which can be used to configure LUFA's * \brief LUFA Library Configuration Header File (Template)
compile time options, as an alternative to the compile time *
constants supplied through a makefile. To use this configuration * This is a header file which can be used to configure LUFA's
header, copy this into your project's root directory and supply * compile time options, as an alternative to the compile time
the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is * constants supplied through a makefile. To use this configuration
defined in all compiled source files. * header, copy this into your project's root directory and supply
* the \c USE_LUFA_CONFIG_HEADER token to the compiler so that it is
For information on what each token does, refer to the LUFA * defined in all compiled source files.
manual section "Summary of Compile Tokens". *
*/ * For information on what each token does, refer to the LUFA
* manual section "Summary of Compile Tokens".
*/
#ifndef __LUFA_CONFIG_H__ #ifndef __LUFA_CONFIG_H__
#define __LUFA_CONFIG_H__ #define __LUFA_CONFIG_H__

2
LUFA/Doxygen.conf
Unescape Escape View File

@ -918,7 +918,7 @@ HTML_FOOTER = ./DoxygenPages/footer.htm
# the style sheet file to the HTML output directory, so don't put your own # the style sheet file to the HTML output directory, so don't put your own
# style sheet in the HTML output directory as well, or it will be erased! # style sheet in the HTML output directory as well, or it will be erased!
HTML_STYLESHEET = HTML_STYLESHEET = ./DoxygenPages/Style.css
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note # other source files which should be copied to the HTML output directory. Note

1087
LUFA/DoxygenPages/Style.css
View File

File diff suppressed because it is too large Load Diff

4
LUFA/DoxygenPages/VIDAndPIDValues.txt
Unescape Escape View File

@ -6,7 +6,7 @@
/** \page Page_VIDPID VID and PID values /** \page Page_VIDPID VID and PID values
* *
* \section Sec_VIDPID_Allocations * \section Sec_VIDPID_Allocations VID and PID Allocations
* The LUFA library uses VID/PID combinations generously donated by Atmel. The following VID/PID combinations * The LUFA library uses VID/PID combinations generously donated by Atmel. The following VID/PID combinations
* are used within the LUFA demos, and thus may be re-used by derivations of each demo. Free PID values may be * are used within the LUFA demos, and thus may be re-used by derivations of each demo. Free PID values may be
* used by future LUFA demo projects. * used by future LUFA demo projects.
@ -415,7 +415,7 @@
* *
* </table> * </table>
* *
* \section Sec_Test_VIDPID The Test VID/PID Combination: * \section Sec_Test_VIDPID The Test VID/PID Combination
* For use in testing of LUFA powered devices during development only, by non-commercial entities. * For use in testing of LUFA powered devices during development only, by non-commercial entities.
* All devices must accept collisions on this VID/PID range (from other in-development LUFA devices) * All devices must accept collisions on this VID/PID range (from other in-development LUFA devices)
* to be resolved by using a unique release number in the Device Descriptor. No devices using this * to be resolved by using a unique release number in the Device Descriptor. No devices using this

2
LUFA/Platform/XMEGA/ClockManagement.h
Unescape Escape View File

@ -251,7 +251,7 @@
/** Starts the DFLL of the XMEGA microcontroller, with the given options. /** Starts the DFLL of the XMEGA microcontroller, with the given options.
* *
* \param[in] Source RC Clock source for the DFLL, a value from \ref XMEGA_System_ClockSource_t. * \param[in] Source RC Clock source for the DFLL, a value from \ref XMEGA_System_ClockSource_t.
* \param[in] Reference Reference clock source for the DFLL, an value from \ref XMEGA_System_DFLLReference_t * \param[in] Reference Reference clock source for the DFLL, an value from \ref XMEGA_System_DFLLReference_t.
* \param[in] Frequency Target frequency of the DFLL's output. * \param[in] Frequency Target frequency of the DFLL's output.
* *
* \return Boolean \c true if the DFLL was successfully started, \c false if invalid parameters specified. * \return Boolean \c true if the DFLL was successfully started, \c false if invalid parameters specified.

Write Preview
Loading…
Cancel
Save