Commit 3008f8ce authored by Dean Camera's avatar Dean Camera
Browse files

Doxygen documentation style changes. Minor documentation corrections.

parent 512b4d87
This diff is collapsed.
......@@ -28,16 +28,18 @@
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 Buttons driver,
for the control of physical board-mounted GPIO pushbuttons.
*/
/** \file
* \brief LUFA Custom Board Button 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 Buttons driver,
* for the control of physical board-mounted GPIO pushbuttons.
*/
#ifndef __BUTTONS_USER_H__
#define __BUTTONS_USER_H__
......
......@@ -28,15 +28,17 @@
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 Dataflash
driver.
/** \file
* \brief LUFA Custom Board Dataflash 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 Dataflash
* driver.
*/
#ifndef __DATAFLASH_USER_H__
......
......@@ -28,15 +28,17 @@
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, for a digital four-way (plus button) joystick.
/** \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__
......
......@@ -28,15 +28,17 @@
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 LEDs driver,
for the LEDs (up to four) mounted on most development boards.
/** \file
* \brief LUFA Custom Board LED 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 LEDs driver,
* for the LEDs (up to four) mounted on most development boards.
*/
#ifndef __LEDS_USER_H__
......
......@@ -28,17 +28,19 @@
this software.
*/
/*
This is a header file which can be used to configure LUFA's
compile time options, as an alternative to the compile time
constants supplied through a makefile. To use this configuration
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
defined in all compiled source files.
For information on what each token does, refer to the LUFA
manual section "Summary of Compile Tokens".
*/
/** \file
* \brief LUFA Library Configuration Header File (Template)
*
* This is a header file which can be used to configure LUFA's
* compile time options, as an alternative to the compile time
* constants supplied through a makefile. To use this configuration
* 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
* defined in all compiled source files.
*
* For information on what each token does, refer to the LUFA
* manual section "Summary of Compile Tokens".
*/
#ifndef __LUFA_CONFIG_H__
#define __LUFA_CONFIG_H__
......
......@@ -918,7 +918,7 @@ HTML_FOOTER = ./DoxygenPages/footer.htm
# 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!
HTML_STYLESHEET =
HTML_STYLESHEET = ./DoxygenPages/Style.css
# 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
......
@media print
{
#top
{
display:none;
}
#side-nav
{
display:none;
}
#nav-path
{
display:none;
}
body
{
overflow:visible;
}
h1,h2,h3,h4,h5,h6
{
page-break-after:avoid;
}
.summary
{
display:none;
}
.memitem
{
page-break-inside:avoid;
}
#doc-content
{
display:inline;
height:auto !important;
margin-left:0 !important;
overflow:inherit;
width:auto !important;
}
pre.fragment
{
overflow:visible;
text-wrap:unrestricted;
white-space:pre-wrap;
word-wrap:break-word;
}
}
body,table,div,p,dl
{
font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size:13px;
line-height:1.3;
}
div.contents p
{
padding-left:12px;
}
div.contents table.memberdecls,.paramname
{
font-family:Consolas, Monaco, courier, sans-serif;
font-size:105%;
padding-right:20px;
}
.title
{
font-size:150%;
font-weight:bold;
margin:10px 2px;
}
h1
{
font-size:30px;
margin-bottom:10px;
padding:0 0 20px;
}
h2
{
color:#42657B;
font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size:17px;
}
h3
{
font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size:15px;
}
h4
{
font-family:Lucida Grande, Verdana, Geneva, Arial, sans-serif;
font-size:13px;
}
dt
{
font-weight:bold;
}
div.multicol
{
-moz-column-count:3px;
-moz-column-gap:1em;
-webkit-column-count:3px;
-webkit-column-gap:1em;
}
p.startli,p.startdd,p.starttd
{
margin-top:2px;
}
p.endli
{
margin-bottom:0;
}
p.enddd
{
margin-bottom:4px;
}
p.endtd
{
margin-bottom:2px;
}
caption
{
font-weight:bold;
}
span.legend
{
font-size:70%;
text-align:center;
}
h3.version
{
font-size:90%;
text-align:center;
}
div.qindex,div.navtab
{
background-color:#EAEFF7;
border:1px solid #9EB3DC;
text-align:center;
}
div.qindex,div.navpath
{
line-height:140%;
width:100%;
}
div.navtab
{
margin-right:15px;
}
a
{
color:#355594;
font-weight:normal;
text-decoration:none;
}
.contents a:visited
{
color:#3D62AB;
}
a:hover
{
text-decoration:underline;
}
a.qindex
{
font-weight:bold;
}
a.qindexHL
{
background-color:#97ADD9;
border:1px double #7F9BD1;
color:#ffffff;
font-weight:bold;
}
.contents a.qindexHL:visited
{
color:#ffffff;
}
a.el
{
font-weight:bold;
}
a.code,a.code:visited
{
color:#4665A2;
}
a.codeRef,a.codeRef:visited
{
color:#4665A2;
}
dl.el
{
margin-left:-1cm;
}
.fragment
{
font-family:monospace, fixed;
font-size:105%;
}
pre.fragment
{
background-color:#F8F8F8;
border:1px solid #C1CEE8;
font-size:10pt;
line-height:125%;
margin:4px 8px 4px 20px;
overflow:auto;
padding:4px 6px;
word-wrap:break-word;
}
div.ah
{
-moz-border-radius:.5em;
-moz-box-shadow:rgba(0, 0, 0, 0.15) 2px 2px 2px;
-webkit-border-radius:.5em;
-webkit-box-shadow:2px 2px 3px #999;
background-color:black;
background-image:0;
border:solid thin #333;
border-radius:0.5em;
box-shadow:2px 2px 3px #999;
color:#ffffff;
font-weight:bold;
margin-bottom:3px;
margin-top:3px;
padding:0.2em;
}
div.groupHeader
{
font-weight:bold;
margin-left:16px;
margin-top:12px;
}
div.groupText
{
font-style:italic;
margin-left:16px;
}
body
{
background-color:white;
color:black;
margin:0;
}
div.contents
{
margin-left:8px;
margin-right:8px;
margin-top:10px;
}
td.indexkey
{
background-color:#EAEFF7;
border:1px solid #C1CEE8;
font-weight:bold;
margin:2px 0;
padding:2px 10px;
vertical-align:top;
white-space:nowrap;
}
td.indexvalue
{
background-color:#EAEFF7;
border:1px solid #C1CEE8;
margin:2px 0;
padding:2px 10px;
}
tr.memlist
{
background-color:#EDF1F8;
}
p.formulaDsp
{
text-align:center;
}
img.formulaInl
{
vertical-align:middle;
}
div.center
{
margin-bottom:0;
margin-top:0;
padding:0;
text-align:center;
}
div.center img
{
border:0;
}
address.footer
{
padding-right:12px;
text-align:right;
}
img.footer
{
border:0;
vertical-align:middle;
}
span.keyword
{
color:#008000;
}
span.keywordtype
{
color:#604020;
}
span.keywordflow
{
color:#e08000;
}
span.comment
{
color:#008000;
}
span.preprocessor
{
color:#806020;
}
span.stringliteral
{
color:#002080;
}
span.charliteral
{
color:#008080;
}
span.vhdldigit
{
color:#ff00ff;
}
span.vhdlchar
{
color:#000000;
}
span.vhdlkeyword
{
color:#700070;
}
span.vhdllogic
{
color:#ff0000;
}
blockquote
{
background-color:#F6F8FC;
border-left:2px solid #97ADD9;
margin:0 24px 0 4px;
padding:0 12px 0 16px;
}
td.tiny
{
font-size:75%;
}
.dirtab
{
border:1px solid #9EB3DC;
border-collapse:collapse;
padding:4px;
}
th.dirtab
{
background:#EAEFF7;
font-weight:bold;
}
hr
{
border:none;
border-top:1px solid #4067B4;
height:0;
}
hr.footer
{
height:1px;
}
table.memberdecls
{
border-spacing:0;
padding:0;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams
{
background-color:#F9FAFC;
border:none;
margin:4px;
padding:1px 0 0 8px;
}
.mdescLeft,.mdescRight
{
color:#555;
padding:0 8px 4px;
}
.memItemLeft,.memItemRight,.memTemplParams
{
border-top:1px solid #C1CEE8;
}
.memItemLeft,.memTemplItemLeft
{
white-space:nowrap;
}
.memItemRight
{
width:100%;
}
.memTemplParams
{