aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-08-05 01:24:47 +0000
committerDavid Robillard <d@drobilla.net>2012-08-05 01:24:47 +0000
commit60596775393fe30f2ca0c402259ec00dfba619fd (patch)
tree5e7c97cc6d079c1181cad4394fe54467dbfd0dd3
parentd3ab967de280b84e541baa77f51a8fe06b601d01 (diff)
downloadlv2-60596775393fe30f2ca0c402259ec00dfba619fd.tar.xz
Improve documentation.
-rw-r--r--doc/doxy-style.css (renamed from doxy-style.css)99
-rw-r--r--doc/reference.doxygen.in10
2 files changed, 73 insertions, 36 deletions
diff --git a/doxy-style.css b/doc/doxy-style.css
index 1e1c3e7..b01ac5d 100644
--- a/doxy-style.css
+++ b/doc/doxy-style.css
@@ -1,5 +1,5 @@
body {
- font-size: 100%;
+ font-size: medium;
font-family: sans-serif;
}
@@ -99,33 +99,24 @@ div.navtab {
/* @group Link Styling */
a {
- color: #3D578C;
+ color: #3D8C57;
text-decoration: none;
}
.contents a:visited {
- color: #4665A2;
+ color: #50755E;
}
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;
}
@@ -188,22 +179,19 @@ div.contents {
margin-right: 10px;
}
-table {
- border-spacing: 0 0.25ex;
-}
-
td.indexkey {
- background-color: #F8F8F8;
+ background-color: #EBEFF6;
font-weight: 700;
- border-top: 1px solid #EEE;
- padding: 0.5ex 1ex 0.5ex 0.5ex;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0;
+ padding: 2px 10px;
}
td.indexvalue {
- background-color: #F7F7F7;
- border-top: 1px solid #EEE;
- padding: 0.5ex;
- margin: 0;
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0;
}
tr.memlist {
@@ -313,11 +301,11 @@ hr.footer {
/* @group Member Descriptions */
table.memberdecls {
border-spacing: 0;
- font-size: 94%;
+ font-size: small;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
- background-color: #F7F7F7;
+ background-color: #FBFBFB;
margin: 0;
padding: 0.25ex;
}
@@ -327,7 +315,7 @@ table.memberdecls {
}
.memItemLeft,.memItemRight,.memTemplParams {
- border-top: 1px solid #EEE;
+ border-top: 1px solid #DDD;
}
.memItemLeft,.memTemplItemLeft {
@@ -361,6 +349,7 @@ table.memberdecls {
.memitem {
padding: 0;
margin: 1ex 0 2ex 0;
+ border: 1px solid #CCC;
}
.memname {
@@ -369,16 +358,15 @@ table.memberdecls {
}
.memproto {
- border-top: 1px solid #DDD;
+ border-bottom: 1px solid #DDD;
padding: 0.5ex;
- color: #253555;
font-weight: bold;
background-color: #F3F3F3;
}
.memdoc {
padding: 1ex;
- background-color: #F7F7F7;
+ background-color: #FBFBFB;
border-top-width: 0;
}
@@ -393,8 +381,6 @@ table.memberdecls {
.paramname {
color: #602020;
white-space: nowrap;
- vertical-align: text-top;
- padding-right: 1em;
}
.paramname em {
@@ -557,5 +543,56 @@ div.header {
}
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