summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/reference.doxygen.in4
-rw-r--r--doc/style.css84
-rw-r--r--suil/suil.h11
-rw-r--r--wscript13
4 files changed, 65 insertions, 47 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
+}
diff --git a/suil/suil.h b/suil/suil.h
index af556a6..02a37cd 100644
--- a/suil/suil.h
+++ b/suil/suil.h
@@ -24,7 +24,7 @@
*/
/**
- @file slv2.h API for Suil, an LV2 UI wrapper library.
+ @file suil.h API for Suil, an LV2 UI wrapper library.
*/
#ifndef SUIL_SUIL_H
@@ -78,10 +78,13 @@ suil_ui_type_supported(const char* host_type_uri,
/**
Instantiate a UI for an LV2 plugin.
- @param uis Set of available UIs for the plugin.
- @param type_uri URI of the desired widget type.
+ @param plugin_uri URI of the plugin to instantiate this UI for.
@param ui_uri URI of a specifically desired UI, or NULL to use the
best choice given @a type_uri.
+ @param ui_bundle_path Path of the UI bundle.
+ @param ui_binary_path Path of the UI binary.
+ @param ui_type_uri URI of the actual UI widget type.
+ @param host_type_uri URI of the desired widget type.
@param write_function Write function as defined by the LV2 UI extension.
@param controller Opaque controller to be passed to @a write_function.
@param features NULL-terminated array of supported features, or NULL.
@@ -162,4 +165,4 @@ suil_instance_extension_data(SuilInstance instance,
} /* extern "C" */
#endif
-#endif /* SUIL_SUIL_H__ */
+#endif /* SUIL_SUIL_H */
diff --git a/wscript b/wscript
index e824451..273a115 100644
--- a/wscript
+++ b/wscript
@@ -1,4 +1,5 @@
#!/usr/bin/env python
+import os
import subprocess
import waflib.Logs as Logs, waflib.Options as Options
@@ -91,5 +92,17 @@ def build(bld):
bld.add_post_fun(autowaf.run_ldconfig)
+def fixdocs(ctx):
+ try:
+ os.chdir('build/doc/html')
+ os.system("sed -i 's/SUIL_API //' group__suil.html")
+ os.system("sed -i 's/SUIL_DEPRECATED //' group__suil.html")
+ os.remove('index.html')
+ os.symlink('group__suil.html',
+ 'index.html')
+ except Exception as e:
+ Logs.error("Failed to fix up Doxygen documentation\n")
+ Logs.error(e)
+
def lint(ctx):
subprocess.call('cpplint.py --filter=-whitespace,+whitespace/comments,-build/header_guard,-readability/casting,-readability/todo src/* suil/*', shell=True)
generated by cgit v1.2.1 (git 2.18.0) at 2024-06-30 18:31:54 +0000