summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2011-03-17 20:10:25 +0000
committerDavid Robillard <d@drobilla.net>2011-03-17 20:10:25 +0000
commitc69ce36bea15426f4793f3247d37019f531e1f1f (patch)
treef3472f180489d4cd047a319c0e670cee319fa2bc /doc
parent2f06c910da4a3a57857f69b1b3e803c18e71deb3 (diff)
downloadsuil-c69ce36bea15426f4793f3247d37019f531e1f1f.tar.gz
suil-c69ce36bea15426f4793f3247d37019f531e1f1f.tar.bz2
suil-c69ce36bea15426f4793f3247d37019f531e1f1f.zip
Improve documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/suil@3111 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'doc')
-rw-r--r--doc/reference.doxygen.in4
-rw-r--r--doc/style.css84
2 files changed, 45 insertions, 43 deletions
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 4f2dcae..b01aa3b 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -74,7 +74,7 @@ BRIEF_MEMBER_DESC = NO
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
-REPEAT_BRIEF = NO
+REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
@@ -527,7 +527,7 @@ WARNINGS = YES
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
-WARN_IF_UNDOCUMENTED = NO
+WARN_IF_UNDOCUMENTED = YES
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
diff --git a/doc/style.css b/doc/style.css
index 2f9b499..82239a2 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -3,24 +3,35 @@ body {
font-family: sans-serif;
}
-.navigation {
+#top {
display: none;
}
-h1 {
- font-size: 160%;
+h1 h2 h3 h4 h5 h6 {
font-weight: bold;
}
+h1 {
+ font-size: 164%;
+}
+
h2 {
- font-size: 130%;
+ font-size: 132%;
}
h3 {
- font-size: 110%;
+ font-size: 124%;
+}
+
+h4 {
+ font-size: 116%;
+}
+
+h5 {
+ font-size: 108%;
}
-h4 h5 h6 {
+h6 {
font-size: 100%;
}
@@ -89,7 +100,6 @@ div.navtab {
/* @group Link Styling */
a {
color: #3D578C;
- font-weight: 400;
text-decoration: none;
}
@@ -102,18 +112,15 @@ a:hover {
}
a.qindex {
- font-weight: 700;
}
a.qindexHL {
- font-weight: 700;
background-color: #9CAFD4;
color: #FFF;
border: 1px double #869DCA;
}
a.el {
- font-weight: 700;
}
a.elRef {
@@ -154,7 +161,7 @@ div.ah {
margin-bottom: 3px;
margin-top: 3px;
padding: .2em;
- border: solid thin #333;
+ border: thin solid #333;
}
div.groupHeader {
@@ -292,8 +299,8 @@ th.dirtab {
hr {
height: 0;
border: none;
- border-top: 1px solid #BBB;
- margin: 3em 0 1em;
+ border-top: 1px solid #DDD;
+ margin: 2em 0 1em;
}
hr.footer {
@@ -303,10 +310,11 @@ hr.footer {
/* @group Member Descriptions */
table.memberdecls {
border-spacing: 0;
+ font-size: 94%;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
- background-color: #F9F9F9;
+ background-color: #FBFBFB;
margin: 0;
padding: 0.25ex;
}
@@ -316,7 +324,7 @@ table.memberdecls {
}
.memItemLeft,.memItemRight,.memTemplParams {
- border-top: 1px solid #DDD;
+ border-top: 1px solid #EEE;
}
.memItemLeft,.memTemplItemLeft {
@@ -335,8 +343,7 @@ table.memberdecls {
.memtemplate {
font-size: 80%;
color: #4665A2;
- font-weight: 400;
- margin-left: 3px;
+ font-weight: bold;
}
.memnav {
@@ -350,31 +357,25 @@ table.memberdecls {
.memitem {
padding: 0;
- margin-bottom: 10px;
+ margin: 1ex 0 2ex 0;
}
.memname {
white-space: nowrap;
- font-weight: 700;
- margin-left: 6px;
+ font-weight: bold;
}
.memproto {
- border-top: 1px solid #A8B8D9;
- border-left: 1px solid #A8B8D9;
- border-right: 1px solid #A8B8D9;
- padding: 6px 0;
+ border-top: 1px solid #DDD;
+ padding: 0.5ex;
color: #253555;
- font-weight: 700;
- background-color: #EEE;
+ font-weight: bold;
+ background-color: #F3F3F3;
}
.memdoc {
- border-bottom: 1px solid #A8A8A8;
- border-left: 1px solid #A8A8A8;
- border-right: 1px solid #A8A8A8;
- padding: 2px 5px;
- background-color: #F9F9F9;
+ padding: 1ex;
+ background-color: #FBFBFB;
border-top-width: 0;
}
@@ -406,7 +407,7 @@ table.memberdecls {
/* these are for tree view when used as main index */
.directory {
font-size: 9pt;
- font-weight: 700;
+ font-weight: bold;
margin: 5px;
}
@@ -437,7 +438,7 @@ table.memberdecls {
/* these are for tree view when not used as main index */
.directory-alt {
font-size: 100%;
- font-weight: 700;
+ font-weight: bold;
}
.directory-alt h3 {
@@ -476,20 +477,21 @@ address {
table.doxtable {
border-collapse: collapse;
+ margin: 0.5ex;
}
table.doxtable td,table.doxtable th {
- border: 1px solid #2D4068;
+ border: 1px solid #DDD;
padding: 3px 7px 2px;
}
table.doxtable th {
- background-color: #374F7F;
- color: #FFF;
- font-size: 110%;
+ background-color: #F3F3F3;
+ color: #000;
padding-bottom: 4px;
padding-top: 5px;
text-align: left;
+ font-weight: bold;
}
.tabsearch {
@@ -506,7 +508,7 @@ table.doxtable th {
height: 30px;
line-height: 30px;
color: #8AA0CC;
- border: solid 1px #C2CDE4;
+ border: 1px solid #C2CDE4;
overflow: hidden;
margin: 0;
padding: 0;
@@ -544,11 +546,11 @@ div.summary a {
}
div.header {
- background-color: #EEE;
+ background-color: #F3F3F3;
margin: 0;
- border-bottom: 1px solid #CCC;
+ border-bottom: 1px solid #DDD;
}
div.headertitle {
padding: 5px 5px 5px 10px;
-} \ No newline at end of file
+}