Commit 49de6a3a authored by Henry's avatar Henry Committed by Andrew Heather
Browse files

Updated documentation

parent 414f2d1d
......@@ -17,7 +17,7 @@ permission for the directory that Doxygen writes files to.
The Doygen configuration file, Doxyfile, in the
$WM_PROJECT_DIR/doc/Doxygen directory is configured to work with
Doxygen versions 1.6.3-1.8.1.
Doxygen versions 1.6.3-1.8.5.
**Note**:
......
......@@ -63,6 +63,9 @@ tr.memlist
background-color: #F0F0F0;
}
.memSeparator {
display:none;
}
#searchli {
padding: 0px;
......@@ -92,3 +95,13 @@ tr.memlist
padding-left: 5px;
}
div.line,
span.comment,
span.keyword,
span.preprocessor,
span.keywordflow,
a.code
{
white-space: pre-wrap;
font-family: "Courier New", Courier, monospace, fixed;
}
......@@ -11,49 +11,49 @@ body, table, div, p, dl {
/* @group Heading Levels */
h1 {
text-align: center;
font-size: 150%;
text-align: center;
font-size: 150%;
}
h2 {
font-size: 120%;
font-size: 120%;
}
h3 {
font-size: 100%;
font-size: 100%;
}
dt {
font-weight: bold;
font-weight: bold;
}
div.multicol {
-moz-column-gap: 1em;
-webkit-column-gap: 1em;
-moz-column-count: 3;
-webkit-column-count: 3;
-moz-column-gap: 1em;
-webkit-column-gap: 1em;
-moz-column-count: 3;
-webkit-column-count: 3;
}
p.startli, p.startdd, p.starttd {
margin-top: 2px;
margin-top: 2px;
}
p.endli {
margin-bottom: 0px;
margin-bottom: 0px;
}
p.enddd {
margin-bottom: 4px;
margin-bottom: 4px;
}
p.endtd {
margin-bottom: 2px;
margin-bottom: 2px;
}
/* @end */
caption {
font-weight: bold;
font-weight: bold;
}
span.legend {
......@@ -67,47 +67,47 @@ h3.version {
}
div.qindex, div.navtab{
background-color: #e8eef2;
border: 1px solid #84b0c7;
text-align: center;
margin: 2px;
padding: 2px;
background-color: #e8eef2;
border: 1px solid #84b0c7;
text-align: center;
margin: 2px;
padding: 2px;
}
div.qindex, div.navpath {
width: 100%;
line-height: 140%;
width: 100%;
line-height: 140%;
}
div.navtab {
margin-right: 15px;
margin-right: 15px;
}
/* @group Link Styling */
a {
color: #153788;
font-weight: normal;
text-decoration: none;
color: #153788;
font-weight: normal;
text-decoration: none;
}
.contents a:visited {
color: #1b77c5;
color: #1b77c5;
}
a:hover {
text-decoration: underline;
text-decoration: underline;
}
a.qindex {
font-weight: bold;
font-weight: bold;
}
a.qindexHL {
font-weight: bold;
background-color: #6666cc;
color: #ffffff;
border: 1px double #9295C2;
font-weight: bold;
background-color: #6666cc;
color: #ffffff;
border: 1px double #9295C2;
}
.contents a.qindexHL:visited {
......@@ -115,7 +115,7 @@ a.qindexHL {
}
a.el {
font-weight: bold;
font-weight: bold;
}
a.elRef {
......@@ -123,18 +123,18 @@ a.elRef {
a.code {
color: #3030f0;;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
a.codeRef {
color: #3030f0;;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
/* @end */
dl.el {
margin-left: -1cm;
margin-left: -1cm;
}
.fragment {
......@@ -143,64 +143,64 @@ dl.el {
}
pre.fragment {
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
overflow: auto;
word-wrap: break-word;
font-size: 9pt;
line-height: 125%;
border: 1px solid #CCCCCC;
background-color: #f5f5f5;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
overflow: auto;
word-wrap: break-word;
font-size: 9pt;
line-height: 125%;
}
div.ah {
background-color: black;
font-weight: bold;
color: #ffffff;
margin-bottom: 3px;
margin-top: 3px
background-color: black;
font-weight: bold;
color: #ffffff;
margin-bottom: 3px;
margin-top: 3px
}
div.groupHeader {
margin-left: 16px;
margin-top: 12px;
margin-bottom: 6px;
font-weight: bold;
margin-left: 16px;
margin-top: 12px;
margin-bottom: 6px;
font-weight: bold;
}
div.groupText {
margin-left: 16px;
font-style: italic;
margin-left: 16px;
font-style: italic;
}
body {
background: white;
color: black;
margin-right: 20px;
margin-left: 20px;
background: white;
color: black;
margin-right: 20px;
margin-left: 20px;
}
td.indexkey {
background-color: #e8eef2;
font-weight: bold;
border: 1px solid #CCCCCC;
margin: 2px 0px 2px 0;
padding: 2px 10px;
background-color: #e8eef2;
font-weight: bold;
border: 1px solid #CCCCCC;
margin: 2px 0px 2px 0;
padding: 2px 10px;
}
td.indexvalue {
background-color: #e8eef2;
border: 1px solid #CCCCCC;
padding: 2px 10px;
margin: 2px 0px;
background-color: #e8eef2;
border: 1px solid #CCCCCC;
padding: 2px 10px;
margin: 2px 0px;
}
tr.memlist {
background-color: #f0f0f0;
background-color: #f0f0f0;
}
p.formulaDsp {
text-align: center;
text-align: center;
}
img.formulaDsp {
......@@ -208,30 +208,30 @@ img.formulaDsp {
}
img.formulaInl {
vertical-align: middle;
vertical-align: middle;
}
div.center {
text-align: center;
text-align: center;
margin-top: 0px;
margin-bottom: 0px;
padding: 0px;
}
div.center img {
border: 0px;
border: 0px;
}
img.footer {
border: 0px;
vertical-align: middle;
border: 0px;
vertical-align: middle;
}
/* @group Code Colorization */
span.keyword {
color: #008000;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.keywordtype {
......@@ -251,81 +251,81 @@ span.comment {
span.preprocessor {
color: #806020;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.stringliteral {
color: #002080;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.charliteral {
color: #008080;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.vhdldigit {
color: #ff00ff;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.vhdlchar {
color: #000000;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.vhdlkeyword {
color: #700070;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
span.vhdllogic {
color: #ff0000;
font-family: "Courier New", Courier, monospace, fixed;
font-family: "Courier New", Courier, monospace, fixed;
}
/* @end */
.search {
color: #003399;
font-weight: bold;
color: #003399;
font-weight: bold;
}
form.search {
margin-bottom: 0px;
margin-top: 0px;
margin-bottom: 0px;
margin-top: 0px;
}
input.search {
font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #e8eef2;
font-size: 75%;
color: #000080;
font-weight: normal;
background-color: #e8eef2;
}
td.tiny {
font-size: 75%;
font-size: 75%;
}
.dirtab {
padding: 4px;
border-collapse: collapse;
border: 1px solid #84b0c7;
padding: 4px;
border-collapse: collapse;
border: 1px solid #84b0c7;
}
th.dirtab {
background: #e8eef2;
font-weight: bold;
background: #e8eef2;
font-weight: bold;
}
hr {
height: 0px;
border: none;
border-top: 1px solid #666;
height: 0px;
border: none;
border-top: 1px solid #666;
}
hr.footer {
height: 1px;
height: 1px;
}
/* @group Member Descriptions */
......@@ -333,19 +333,19 @@ hr.footer {
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
background-color: #FAFAFA;
border: none;
margin: 4px;
padding: 1px 0 0 8px;
background-color: #FAFAFA;
border: none;
margin: 4px;
padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
padding: 0px 8px 4px 8px;
color: #555;
padding: 0px 8px 4px 8px;
color: #555;
}
.memItemLeft, .memItemRight, .memTemplParams {
border-top: 1px solid #ccc;
border-top: 1px solid #ccc;
}
.memItemLeft, .memTemplItemLeft {
......@@ -353,7 +353,7 @@ hr.footer {
}
.memTemplParams {
color: #606060;
color: #606060;
white-space: nowrap;
}
......@@ -364,24 +364,24 @@ hr.footer {
/* Styles for detailed member documentation */
.memtemplate {
font-size: 80%;
color: #606060;
font-weight: normal;
margin-left: 3px;
font-size: 80%;
color: #606060;
font-weight: normal;
margin-left: 3px;
}
.memnav {
background-color: #e8eef2;
border: 1px solid #84b0c7;
text-align: center;
margin: 2px;
margin-right: 15px;
padding: 2px;
background-color: #e8eef2;
border: 1px solid #84b0c7;
text-align: center;
margin: 2px;
margin-right: 15px;
padding: 2px;
}
.memitem {
padding: 0;
margin-bottom: 10px;
padding: 0;
margin-bottom: 10px;
}
.memname {
......@@ -428,19 +428,19 @@ hr.footer {
}
.paramkey {
text-align: right;
text-align: right;
}
.paramtype {
white-space: nowrap;
white-space: nowrap;
}
.paramname {
color: #602020;
white-space: nowrap;
color: #602020;
white-space: nowrap;
}
.paramname em {
font-style: normal;
font-style: normal;
}
/* @end */
......@@ -450,21 +450,21 @@ hr.footer {
/* for the tree view */
.ftvtree {
font-family: sans-serif;
margin: 0.5em;
font-family: sans-serif;
margin: 0.5em;
}
/* these are for tree view when used as main index */
.directory {
font-size: 9pt;
font-weight: bold;
font-size: 9pt;
font-weight: bold;
}
.directory h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
margin: 0px;
margin-top: 1em;
font-size: 11pt;
}
/*
......@@ -476,86 +476,86 @@ proper pixel height of your image.
/*
.directory h3.swap {
height: 61px;
background-repeat: no-repeat;
background-image: url("yourimage.gif");
height: 61px;
background-repeat: no-repeat;
background-image: url("yourimage.gif");
}
.directory h3.swap span {
display: none;
display: none;
}
*/
.directory > h3 {
margin-top: 0;
margin-top: 0;
}
.directory p {
margin: 0px;
white-space: nowrap;
margin: 0px;
white-space: nowrap;
}
.directory div {
display: none;
margin: 0px;
display: none;
margin: 0px;
}
.directory img {
vertical-align: -30%;
vertical-align: -30%;
}
/* these are for tree view when not used as main index */
.directory-alt {
font-size: 100%;
font-weight: bold;
font-size: 100%;
font-weight: bold;
}
.directory-alt h3 {
margin: 0px;
margin-top: 1em;
font-size: 11pt;
margin: 0px;
margin-top: 1em;
font-size: 11pt;
}
.directory-alt > h3 {
margin-top: 0;
margin-top: 0;
}
.directory-alt p {
margin: 0px;
white-space: nowrap;
margin: 0px;
white-space: nowrap;
}
.directory-alt div {
display: none;
margin: 0px;
display: none;
margin: 0px;
}