From 60596775393fe30f2ca0c402259ec00dfba619fd Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 5 Aug 2012 01:24:47 +0000 Subject: Improve documentation. --- doc/doxy-style.css | 598 +++++++++++++++++++++++++++++++++++++++++++++++ doc/reference.doxygen.in | 10 +- doxy-style.css | 561 -------------------------------------------- 3 files changed, 603 insertions(+), 566 deletions(-) create mode 100644 doc/doxy-style.css delete mode 100644 doxy-style.css diff --git a/doc/doxy-style.css b/doc/doxy-style.css new file mode 100644 index 0000000..b01ac5d --- /dev/null +++ b/doc/doxy-style.css @@ -0,0 +1,598 @@ +body { + font-size: medium; + font-family: sans-serif; +} + +#titlearea { + display: none; +} + +h1 h2 h3 h4 h5 h6 { + font-weight: bold; +} + +h1 { + font-size: 164%; +} + +h2 { + font-size: 132%; +} + +h3 { + font-size: 124%; +} + +h4 { + font-size: 116%; +} + +h5 { + font-size: 108%; +} + +h6 { + font-size: 100%; +} + +p { + margin: 0 0 1ex 0; +} + +br { + display: none; +} + +dt { + font-weight: 700; +} + +div.multicol { +} + +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: 700; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex,div.navtab { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex,div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ +a { + color: #3D8C57; + text-decoration: none; +} + +.contents a:visited { + color: #50755E; +} + +a:hover { + text-decoration: underline; +} + +a.qindexHL { + background-color: #9CAFD4; + color: #FFF; + border: 1px double #869DCA; +} + +a.code { + color: #4665A2; +} + +a.codeRef { + color: #4665A2; +} + +/* @end */ +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #C4C4C4; + background-color: #F9F9F9; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: #000; + font-weight: 700; + color: #FFF; + margin-bottom: 3px; + margin-top: 3px; + padding: .2em; + border: thin solid #333; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: 700; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: #FFF; + color: #000; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 10px; + margin-right: 10px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: 700; + border: 1px solid #C4CFE5; + margin: 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0; + margin-bottom: 0; + padding: 0; +} + +div.center img { + border: 0; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0; + vertical-align: middle; +} + +/* @group Code Colorization */ +span.keyword { + color: green; +} + +span.keywordtype { + color: #604020; +} + +span.keywordflow { + color: #e08000; +} + +span.comment { + color: maroon; +} + +span.preprocessor { + color: #806020; +} + +span.stringliteral { + color: #002080; +} + +span.charliteral { + color: teal; +} + +span.vhdldigit { + color: #F0F; +} + +span.vhdlkeyword { + color: #700070; +} + +span.vhdllogic { + color: red; +} + +/* @end */ +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: 700; +} + +hr { + height: 0; + border: none; + border-top: 1px solid #DDD; + margin: 2em 0 1em; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ +table.memberdecls { + border-spacing: 0; + font-size: small; +} + +.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams { + background-color: #FBFBFB; + margin: 0; + padding: 0.25ex; +} + +.mdescLeft,.mdescRight { + color: #555; +} + +.memItemLeft,.memItemRight,.memTemplParams { + border-top: 1px solid #DDD; +} + +.memItemLeft,.memTemplItemLeft { + white-space: nowrap; + padding-left: 2em; +} + +.memTemplParams { + color: #464646; + white-space: nowrap; +} + +/* @end */ +/* @group Member Details */ +/* Styles for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: bold; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; + margin: 1ex 0 2ex 0; + border: 1px solid #CCC; +} + +.memname { + white-space: nowrap; + font-weight: bold; +} + +.memproto { + border-bottom: 1px solid #DDD; + padding: 0.5ex; + font-weight: bold; + background-color: #F3F3F3; +} + +.memdoc { + padding: 1ex; + background-color: #FBFBFB; + border-top-width: 0; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} + +.paramname em { + font-style: normal; +} + +/* @end */ +/* @group Directory (tree) */ +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin: 0; +} + +/* these are for tree view when used as main index */ +.directory { + font-size: 9pt; + font-weight: bold; + margin: 5px; +} + +.directory h3 { + margin: 0; + margin-top: 1em; + font-size: 11pt; +} + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ +div.dynheader { + margin-top: 8px; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse: collapse; + margin: 0.5ex; +} + +table.doxtable td,table.doxtable th { + border: 1px solid #DDD; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #F3F3F3; + color: #000; + padding-bottom: 4px; + padding-top: 5px; + text-align: left; + font-weight: bold; +} + +.tabsearch { + top: 0; + left: 10px; + height: 36px; + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul { + font-size: 11px; + height: 30px; + line-height: 30px; + color: #8AA0CC; + border: 1px solid #C2CDE4; + overflow: hidden; + margin: 0; + padding: 0; +} + +.navpath li { + list-style-type: none; + float: left; + padding-left: 10px; + padding-right: 15px; + color: #364D7C; +} + +.navpath a { + height: 32px; + display: block; + text-decoration: none; + outline: none; +} + +.navpath a:hover { + color: #6884BD; +} + +div.summary { + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a { + white-space: nowrap; +} + +div.header { + background-color: #F3F3F3; + margin: 0; + border-bottom: 1px solid #DDD; +} + +div.headertitle { + background-color: #ECF3F1; + padding: 5px 5px 5px 10px; + font-size: 180%; + font-weight: bold; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index 364c697..fb0be10 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -920,7 +920,7 @@ HTML_FOOTER = # 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 = doxy-style.css +HTML_STYLESHEET = @LV2_SRCDIR@/doc/doxy-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 @@ -939,13 +939,13 @@ HTML_EXTRA_FILES = # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. # The allowed range is 0 to 359. -HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_HUE = 160 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # the colors in the HTML output. For a value of 0 the output will use # grayscales only. A value of 255 will produce the most vivid colors. -HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_SAT = 60 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # the luminance component of the colors in the HTML output. Values below @@ -954,7 +954,7 @@ HTML_COLORSTYLE_SAT = 100 # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, # and 100 does not change the gamma. -HTML_COLORSTYLE_GAMMA = 80 +HTML_COLORSTYLE_GAMMA = 100 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting @@ -1569,7 +1569,7 @@ TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = build/tags +GENERATE_TAGFILE = tags # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes diff --git a/doxy-style.css b/doxy-style.css deleted file mode 100644 index 1e1c3e7..0000000 --- a/doxy-style.css +++ /dev/null @@ -1,561 +0,0 @@ -body { - font-size: 100%; - font-family: sans-serif; -} - -#titlearea { - display: none; -} - -h1 h2 h3 h4 h5 h6 { - font-weight: bold; -} - -h1 { - font-size: 164%; -} - -h2 { - font-size: 132%; -} - -h3 { - font-size: 124%; -} - -h4 { - font-size: 116%; -} - -h5 { - font-size: 108%; -} - -h6 { - font-size: 100%; -} - -p { - margin: 0 0 1ex 0; -} - -br { - display: none; -} - -dt { - font-weight: 700; -} - -div.multicol { -} - -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: 700; -} - -span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.qindex,div.navtab { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - padding: 2px; -} - -div.qindex,div.navpath { - width: 100%; - line-height: 140%; -} - -div.navtab { - margin-right: 15px; -} - -/* @group Link Styling */ -a { - color: #3D578C; - text-decoration: none; -} - -.contents a:visited { - color: #4665A2; -} - -a:hover { - text-decoration: underline; -} - -a.qindex { -} - -a.qindexHL { - background-color: #9CAFD4; - color: #FFF; - border: 1px double #869DCA; -} - -a.el { -} - -a.elRef { -} - -a.code { - color: #4665A2; -} - -a.codeRef { - color: #4665A2; -} - -/* @end */ -dl.el { - margin-left: -1cm; -} - -.fragment { - font-family: monospace, fixed; - font-size: 105%; -} - -pre.fragment { - border: 1px solid #C4C4C4; - background-color: #F9F9F9; - padding: 4px 6px; - margin: 4px 8px 4px 2px; - overflow: auto; - font-size: 9pt; - line-height: 125%; -} - -div.ah { - background-color: #000; - font-weight: 700; - color: #FFF; - margin-bottom: 3px; - margin-top: 3px; - padding: .2em; - border: thin solid #333; -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: 700; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background: #FFF; - color: #000; - margin: 0; -} - -div.contents { - margin-top: 10px; - margin-left: 10px; - margin-right: 10px; -} - -table { - border-spacing: 0 0.25ex; -} - -td.indexkey { - background-color: #F8F8F8; - font-weight: 700; - border-top: 1px solid #EEE; - padding: 0.5ex 1ex 0.5ex 0.5ex; -} - -td.indexvalue { - background-color: #F7F7F7; - border-top: 1px solid #EEE; - padding: 0.5ex; - margin: 0; -} - -tr.memlist { - background-color: #EEF1F7; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { -} - -img.formulaInl { - vertical-align: middle; -} - -div.center { - text-align: center; - margin-top: 0; - margin-bottom: 0; - padding: 0; -} - -div.center img { - border: 0; -} - -address.footer { - text-align: right; - padding-right: 12px; -} - -img.footer { - border: 0; - vertical-align: middle; -} - -/* @group Code Colorization */ -span.keyword { - color: green; -} - -span.keywordtype { - color: #604020; -} - -span.keywordflow { - color: #e08000; -} - -span.comment { - color: maroon; -} - -span.preprocessor { - color: #806020; -} - -span.stringliteral { - color: #002080; -} - -span.charliteral { - color: teal; -} - -span.vhdldigit { - color: #F0F; -} - -span.vhdlkeyword { - color: #700070; -} - -span.vhdllogic { - color: red; -} - -/* @end */ -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #A3B4D7; -} - -th.dirtab { - background: #EBEFF6; - font-weight: 700; -} - -hr { - height: 0; - border: none; - border-top: 1px solid #DDD; - margin: 2em 0 1em; -} - -hr.footer { - height: 1px; -} - -/* @group Member Descriptions */ -table.memberdecls { - border-spacing: 0; - font-size: 94%; -} - -.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams { - background-color: #F7F7F7; - margin: 0; - padding: 0.25ex; -} - -.mdescLeft,.mdescRight { - color: #555; -} - -.memItemLeft,.memItemRight,.memTemplParams { - border-top: 1px solid #EEE; -} - -.memItemLeft,.memTemplItemLeft { - white-space: nowrap; - padding-left: 2em; -} - -.memTemplParams { - color: #464646; - white-space: nowrap; -} - -/* @end */ -/* @group Member Details */ -/* Styles for detailed member documentation */ -.memtemplate { - font-size: 80%; - color: #4665A2; - font-weight: bold; -} - -.memnav { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.memitem { - padding: 0; - margin: 1ex 0 2ex 0; -} - -.memname { - white-space: nowrap; - font-weight: bold; -} - -.memproto { - border-top: 1px solid #DDD; - padding: 0.5ex; - color: #253555; - font-weight: bold; - background-color: #F3F3F3; -} - -.memdoc { - padding: 1ex; - background-color: #F7F7F7; - border-top-width: 0; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; - vertical-align: text-top; - padding-right: 1em; -} - -.paramname em { - font-style: normal; -} - -/* @end */ -/* @group Directory (tree) */ -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin: 0; -} - -/* these are for tree view when used as main index */ -.directory { - font-size: 9pt; - font-weight: bold; - margin: 5px; -} - -.directory h3 { - margin: 0; - margin-top: 1em; - font-size: 11pt; -} - -.directory > h3 { - margin-top: 0; -} - -.directory p { - margin: 0; - white-space: nowrap; -} - -.directory div { - display: none; - margin: 0; -} - -.directory img { - vertical-align: -30%; -} - -/* these are for tree view when not used as main index */ -.directory-alt { - font-size: 100%; - font-weight: bold; -} - -.directory-alt h3 { - margin: 0; - margin-top: 1em; - font-size: 11pt; -} - -.directory-alt > h3 { - margin-top: 0; -} - -.directory-alt p { - margin: 0; - white-space: nowrap; -} - -.directory-alt div { - display: none; - margin: 0; -} - -.directory-alt img { - vertical-align: -30%; -} - -/* @end */ -div.dynheader { - margin-top: 8px; -} - -address { - font-style: normal; - color: #2A3D61; -} - -table.doxtable { - border-collapse: collapse; - margin: 0.5ex; -} - -table.doxtable td,table.doxtable th { - border: 1px solid #DDD; - padding: 3px 7px 2px; -} - -table.doxtable th { - background-color: #F3F3F3; - color: #000; - padding-bottom: 4px; - padding-top: 5px; - text-align: left; - font-weight: bold; -} - -.tabsearch { - top: 0; - left: 10px; - height: 36px; - z-index: 101; - overflow: hidden; - font-size: 13px; -} - -.navpath ul { - font-size: 11px; - height: 30px; - line-height: 30px; - color: #8AA0CC; - border: 1px solid #C2CDE4; - overflow: hidden; - margin: 0; - padding: 0; -} - -.navpath li { - list-style-type: none; - float: left; - padding-left: 10px; - padding-right: 15px; - color: #364D7C; -} - -.navpath a { - height: 32px; - display: block; - text-decoration: none; - outline: none; -} - -.navpath a:hover { - color: #6884BD; -} - -div.summary { - float: right; - font-size: 8pt; - padding-right: 5px; - width: 50%; - text-align: right; -} - -div.summary a { - white-space: nowrap; -} - -div.header { - background-color: #F3F3F3; - margin: 0; - border-bottom: 1px solid #DDD; -} - -div.headertitle { - padding: 5px 5px 5px 10px; -} -- cgit v1.2.1