aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-11-25 00:23:48 -0500
committerDavid Robillard <d@drobilla.net>2014-11-25 00:23:48 -0500
commit68a4dc89f5e00aa6e2780f4f96011b92961b7a80 (patch)
tree22882da1f402bd6067415e687f9061c77680c198 /doc
parent1754a6fe0866fcf84846722f45042caa698d1aea (diff)
downloadlv2-68a4dc89f5e00aa6e2780f4f96011b92961b7a80.tar.xz
Single-page API documentation with unified style.
Diffstat (limited to 'doc')
-rw-r--r--doc/DoxygenLayout.xml194
-rw-r--r--doc/doxy-style.css172
-rw-r--r--doc/header.html1
-rw-r--r--doc/reference.doxygen.in11
-rw-r--r--doc/style.css71
5 files changed, 392 insertions, 57 deletions
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml
new file mode 100644
index 0000000..22acafb
--- /dev/null
+++ b/doc/DoxygenLayout.xml
@@ -0,0 +1,194 @@
+<doxygenlayout version="1.0">
+ <!-- Generated by doxygen 1.8.8 -->
+ <!-- Navigation index tabs for HTML output -->
+ <navindex>
+ <tab type="user" url="../../ns/index.html" title="Index"/>
+ <tab type="mainpage" visible="no" title=""/>
+ <tab type="pages" visible="yes" title="" intro=""/>
+ <tab type="modules" visible="yes" title="" intro=""/>
+ <tab type="namespaces" visible="yes" title="">
+ <tab type="namespacelist" visible="yes" title="" intro=""/>
+ <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="classes" visible="yes" title="">
+ <tab type="classlist" visible="yes" title="" intro=""/>
+ <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="hierarchy" visible="yes" title="" intro=""/>
+ <tab type="classmembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="files" visible="yes" title="">
+ <tab type="filelist" visible="yes" title="" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="examples" visible="yes" title="" intro=""/>
+ </navindex>
+
+ <!-- Layout definition for a class page -->
+ <class>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <inheritancegraph visible="$CLASS_GRAPH"/>
+ <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+ <memberdecl>
+ <nestedclasses visible="yes" title=""/>
+ <publictypes title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <publicslots title=""/>
+ <signals title=""/>
+ <publicmethods title=""/>
+ <publicstaticmethods title=""/>
+ <publicattributes title=""/>
+ <publicstaticattributes title=""/>
+ <protectedtypes title=""/>
+ <protectedslots title=""/>
+ <protectedmethods title=""/>
+ <protectedstaticmethods title=""/>
+ <protectedattributes title=""/>
+ <protectedstaticattributes title=""/>
+ <packagetypes title=""/>
+ <packagemethods title=""/>
+ <packagestaticmethods title=""/>
+ <packageattributes title=""/>
+ <packagestaticattributes title=""/>
+ <properties title=""/>
+ <events title=""/>
+ <privatetypes title=""/>
+ <privateslots title=""/>
+ <privatemethods title=""/>
+ <privatestaticmethods title=""/>
+ <privateattributes title=""/>
+ <privatestaticattributes title=""/>
+ <friends title=""/>
+ <related title="" subtitle=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <constructors title=""/>
+ <functions title=""/>
+ <related title=""/>
+ <variables title=""/>
+ <properties title=""/>
+ <events title=""/>
+ </memberdef>
+ <allmemberslink visible="yes"/>
+ <usedfiles visible="$SHOW_USED_FILES"/>
+ <authorsection visible="yes"/>
+ </class>
+
+ <!-- Layout definition for a namespace page -->
+ <namespace>
+ <briefdescription visible="yes"/>
+ <memberdecl>
+ <nestednamespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </namespace>
+
+ <!-- Layout definition for a file page -->
+ <file>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <includegraph visible="$INCLUDE_GRAPH"/>
+ <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+ <sourcelink visible="yes"/>
+ <memberdecl>
+ <classes visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection/>
+ </file>
+
+ <!-- Layout definition for a group page -->
+ <group>
+ <detaileddescription title=""/>
+ <groupgraph visible="$GROUP_GRAPHS"/>
+ <memberdecl>
+ <nestedgroups visible="yes" title=""/>
+ <dirs visible="yes" title=""/>
+ <files visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <defines title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <memberdef>
+ <pagedocs/>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </group>
+
+ <!-- Layout definition for a directory page -->
+ <directory>
+ <briefdescription visible="yes"/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ </directory>
+</doxygenlayout>
diff --git a/doc/doxy-style.css b/doc/doxy-style.css
index b01ac5d..e98848d 100644
--- a/doc/doxy-style.css
+++ b/doc/doxy-style.css
@@ -88,11 +88,6 @@ div.qindex,div.navtab {
padding: 2px;
}
-div.qindex,div.navpath {
- width: 100%;
- line-height: 140%;
-}
-
div.navtab {
margin-right: 15px;
}
@@ -162,6 +157,10 @@ div.groupHeader {
font-weight: 700;
}
+a + h2.groupheader {
+ display: none;
+}
+
div.groupText {
margin-left: 16px;
font-style: italic;
@@ -236,7 +235,7 @@ span.keyword {
}
span.keywordtype {
- color: #604020;
+ color: #3E873E;
}
span.keywordflow {
@@ -300,14 +299,12 @@ hr.footer {
/* @group Member Descriptions */
table.memberdecls {
- border-spacing: 0;
- font-size: small;
+ border-spacing: 0.125em;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
- background-color: #FBFBFB;
margin: 0;
- padding: 0.25ex;
+ padding: 0;
}
.mdescLeft,.mdescRight {
@@ -315,7 +312,7 @@ table.memberdecls {
}
.memItemLeft,.memItemRight,.memTemplParams {
- border-top: 1px solid #DDD;
+ border: 0;
}
.memItemLeft,.memTemplItemLeft {
@@ -323,11 +320,19 @@ table.memberdecls {
padding-left: 2em;
}
+.memItemLeft a.el {
+ font-weight: bold;
+}
+
.memTemplParams {
color: #464646;
white-space: nowrap;
}
+td.memSeparator {
+ display: none;
+}
+
/* @end */
/* @group Member Details */
/* Styles for detailed member documentation */
@@ -349,7 +354,8 @@ table.memberdecls {
.memitem {
padding: 0;
margin: 1ex 0 2ex 0;
- border: 1px solid #CCC;
+ border: 1px solid #333;
+ border-radius: 6px;
}
.memname {
@@ -362,12 +368,20 @@ table.memberdecls {
padding: 0.5ex;
font-weight: bold;
background-color: #F3F3F3;
+ border-radius: 6px 6px 0 0;
+ background: linear-gradient(to bottom, #444 0%, #000 100%);
+ color: #FFF;
+}
+
+.memproto .paramname {
+ color: #CCC;
}
.memdoc {
padding: 1ex;
background-color: #FBFBFB;
border-top-width: 0;
+ border-radius: 0 0 6px 6px;
}
.paramkey {
@@ -375,6 +389,7 @@ table.memberdecls {
}
.paramtype {
+ color: #3E873E;
white-space: nowrap;
}
@@ -397,9 +412,8 @@ table.memberdecls {
/* these are for tree view when used as main index */
.directory {
- font-size: 9pt;
- font-weight: bold;
- margin: 5px;
+ font-size: small;
+ margin: 0.5em;
}
.directory h3 {
@@ -494,12 +508,13 @@ table.doxtable th {
font-size: 13px;
}
+div.navpath {
+ padding: 0.25em;
+}
+
.navpath ul {
- font-size: 11px;
- height: 30px;
- line-height: 30px;
+ font-size: x-small;
color: #8AA0CC;
- border: 1px solid #C2CDE4;
overflow: hidden;
margin: 0;
padding: 0;
@@ -514,7 +529,6 @@ table.doxtable th {
}
.navpath a {
- height: 32px;
display: block;
text-decoration: none;
outline: none;
@@ -526,8 +540,8 @@ table.doxtable th {
div.summary {
float: right;
- font-size: 8pt;
- padding-right: 5px;
+ font-size: x-small;
+ padding: 0.25em 0.5em 0 0;
width: 50%;
text-align: right;
}
@@ -540,40 +554,33 @@ div.header {
background-color: #F3F3F3;
margin: 0;
border-bottom: 1px solid #DDD;
+ border-radius: 0 0 6px 6px;
}
div.headertitle {
- background-color: #ECF3F1;
- padding: 5px 5px 5px 10px;
font-size: 180%;
font-weight: bold;
+ color: #FFF;
+ padding: 0.125em 0.25em 0.125em 0.25em;
+ background-color: #333;
+ background: linear-gradient(to bottom, #444 0%, #000 100%);
+ border: 0;
+ border-top: solid 2px #444;
+ border-bottom: solid 2px #444;
+ border-radius: 0 0 6px 6px;
}
div.line {
font-family: monospace, fixed;
- font-size: 13px;
+ 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+ */
+ white-space: pre-wrap;
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 {
@@ -587,7 +594,7 @@ span.lineno {
text-align: right;
border-right: 2px solid #0F0;
background-color: #E8E8E8;
- white-space: pre;
+ white-space: pre;
}
span.lineno a {
background-color: #D8D8D8;
@@ -596,3 +603,86 @@ span.lineno a {
span.lineno a:hover {
background-color: #C8C8C8;
}
+
+.tabs, .tabs2, .navpath {
+ background-image: none;
+ background-color: #333;
+ background: linear-gradient(to bottom, #444 0%, #000 100%);
+ border: 0;
+ border-bottom: solid 2px #000;
+ padding: 0;
+ padding-top: 2px;
+}
+
+#navrow1 {
+ border: 0;
+}
+
+th {
+ text-align: left;
+}
+
+.mlabel {
+ padding: 0.125em;
+}
+
+/* tabs*/
+
+.tabs, .tabs2, .tabs3 {
+ width: 100%;
+ z-index: 101;
+ font-size: large;
+}
+
+.tabs2 {
+ font-size: 10px;
+}
+.tabs3 {
+ font-size: 9px;
+}
+
+.tablist {
+ margin: 0;
+ padding: 0;
+ display: table;
+}
+
+.tablist li {
+ float: left;
+ display: table-cell;
+ line-height: 2em;
+ list-style: none;
+ background-color: #333;
+ background: linear-gradient(to bottom, #555 0%, #111 100%);
+ border: solid 1px #000;
+ border-radius: 6px 6px 0 0;
+ color: #fff;
+}
+
+.tablist a {
+ display: block;
+ padding: 0 20px;
+ font-weight: bold;
+ color: #fff;
+ text-decoration: none;
+ outline: none;
+}
+
+.tabs3 .tablist a {
+ padding: 0 10px;
+}
+
+.tablist a:hover {
+ color: #fff;
+ text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+ text-decoration: none;
+}
+
+.tablist li.current a {
+ color: #fff;
+ text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+}
+
+span.icon {
+ display: none;
+} \ No newline at end of file
diff --git a/doc/header.html b/doc/header.html
index 6ff2e60..d91ed6a 100644
--- a/doc/header.html
+++ b/doc/header.html
@@ -3,7 +3,6 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>LV2: File List</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxy-style.css" rel="stylesheet" type="text/css" />
</head>
<body>
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index e071c9c..ae1c2e3 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -98,7 +98,7 @@ OUTPUT_LANGUAGE = English
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
-BRIEF_MEMBER_DESC = YES
+BRIEF_MEMBER_DESC = NO
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# description of a member or function before the detailed description
@@ -361,7 +361,7 @@ SUBGROUPING = YES
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
-INLINE_GROUPED_CLASSES = NO
+INLINE_GROUPED_CLASSES = YES
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
@@ -672,7 +672,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
-LAYOUT_FILE =
+LAYOUT_FILE = DoxygenLayout.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
@@ -765,11 +765,15 @@ INPUT = @LV2_SRCDIR@/doc/mainpage.dox \
lv2/lv2plug.in/ns/ext/event/event.h \
lv2/lv2plug.in/ns/ext/instance-access/instance-access.h \
lv2/lv2plug.in/ns/ext/log/log.h \
+ lv2/lv2plug.in/ns/ext/log/logger.h \
lv2/lv2plug.in/ns/ext/midi/midi.h \
lv2/lv2plug.in/ns/ext/morph/morph.h \
lv2/lv2plug.in/ns/ext/options/options.h \
+ lv2/lv2plug.in/ns/ext/parameters/parameters.h \
lv2/lv2plug.in/ns/ext/patch/patch.h \
lv2/lv2plug.in/ns/ext/port-groups/port-groups.h \
+ lv2/lv2plug.in/ns/ext/port-props/port-props.h \
+ lv2/lv2plug.in/ns/ext/presets/presets.h \
lv2/lv2plug.in/ns/ext/resize-port/resize-port.h \
lv2/lv2plug.in/ns/ext/state/state.h \
lv2/lv2plug.in/ns/ext/time/time.h \
@@ -777,6 +781,7 @@ INPUT = @LV2_SRCDIR@/doc/mainpage.dox \
lv2/lv2plug.in/ns/ext/urid/urid.h \
lv2/lv2plug.in/ns/ext/worker/worker.h \
lv2/lv2plug.in/ns/extensions/ui/ui.h \
+ lv2/lv2plug.in/ns/extensions/units/units.h \
lv2/lv2plug.in/ns/lv2core/lv2.h
# This tag can be used to specify the character encoding of the source files
diff --git a/doc/style.css b/doc/style.css
index a2c682a..afb41f7 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -130,14 +130,15 @@ h6 {
position: absolute;
right: 0;
top: 0;
- padding: 1ex;
- margin: 0.5ex 0.25ex 0 0.5ex;
+ padding: 0.5em;
font-size: x-small;
border-style: hidden;
}
#meta tr, #meta th, #meta td {
border: 0;
font-weight: normal;
+ padding: 0.125em 0.25em 0.125em 0.25em;
+ background-color: transparent;
}
#meta th {
text-align: right;
@@ -148,8 +149,8 @@ h6 {
#title {
font-size: 200%;
font-weight: 700;
- margin: 0 0 0.25ex 0;
- padding: 0 0 0 0;
+ margin: 0;
+ padding: 0;
}
#subtitle {
font-size: small;
@@ -472,8 +473,6 @@ ul, ol {
background-color: #222;
background: linear-gradient(to bottom, #444 0%, #000 100%);
border-bottom: solid 2px #444;
- border-left: solid 2px #444;
- border-right: solid 2px #444;
border-radius: 0 0 6px 6px;
color: #EEE;
margin: 0;
@@ -499,6 +498,42 @@ ul, ol {
}
.index {
margin-left: 1em;
+ border-collapse: initial;
+ border-spacing: 0;
+ border-radius: 6px;
+}
+.index th {
+ color: #FFF;
+ background-color: #222;
+ background: linear-gradient(to bottom, #444 0%, #000 100%);
+ border: 0;
+ border-right: solid 1px #333;
+ border-bottom: solid 1px #333;
+}
+.index td {
+ vertical-align: top;
+ border: 0;
+ border-right: solid 1px #DDD;
+ border-bottom: solid 1px #DDD;
+}
+.index td:first-child {
+ border-left: solid 1px #DDD;
+}
+.index ul {
+ padding-left: 1em;
+ border-collapse: initial;
+}
+.index thead tr th:first-child {
+ border-radius: 6px 0 0 0;
+}
+.index thead tr th:last-child {
+ border-radius: 0 6px 0 0;
+}
+.index tbody tr:last-child td:first-child {
+ border-radius:0 0 0 6px;
+}
+.index tbody tr:last-child td:last-child {
+ border-radius:0 0 6px 0;
}
.prop {
margin: 0;
@@ -527,12 +562,19 @@ ul, ol {
vertical-align: text-top;
}
.terminfo th {
- padding: 0 1ex 0 0;
+ padding: 0.25em 0.75em 0.125em 0;
+ border: 0;
+ border-bottom: 1px solid #ddd;
+}
+.terminfo td {
+ padding: 0;
+ border: 0;
+ border-bottom: 1px solid #ddd;
}
.specterm {
background-color: #FBFBFB;
border: 0;
- border: 1px solid #444;
+ border: 1px solid #333;
margin: 0;
padding: 0;
margin-bottom: 1em;
@@ -545,7 +587,7 @@ ul, ol {
color: #FFF;
background-color: #222;
background: linear-gradient(to bottom, #444 0%, #000 100%);
- border: solid 2px #444;
+ border: solid 1px #333;
border-radius: 6px 6px 0 0;
}
.spectermbody {
@@ -581,15 +623,20 @@ div.head table {
table {
border-collapse: collapse;
border-style: hidden;
+ border-spacing: 0;
margin: 0;
border: 0;
}
th {
- vertical-align: text-top;
+ background-color: #F8F8F8;
}
td, th {
- border: 1px dashed #ccc;
- padding: 0.3ex 0.5em 0.3ex 0.5em;
+ border: 1px solid #ddd;
+ padding: 0.25em 0.5em 0.25em 0.5em;
+}
+th {
+ font-weight: bold;
+ text-align: left;
}
pre {
margin: 1em 1em 1em 4em;