Browse Source

Update documentation

zrythm_meson
David Robillard 3 years ago
parent
commit
432d60b600
  1. 10
      README
  2. 11
      README.md
  3. 20
      doc/footer.html
  4. 37
      doc/header.html
  5. 49
      doc/layout.xml
  6. 6
      doc/mainpage.md
  7. 27
      doc/reference.doxygen.in
  8. 396
      doc/style.css
  9. 6
      wscript

10
README

@ -1,10 +0,0 @@ @@ -1,10 +0,0 @@
Sratom
======
Sratom is a library for serialising LV2 atoms to/from RDF, particularly the
Turtle syntax.
For more information, see <http://drobilla.net/software/sratom>.
More information about LV2 atoms can be found at <http://lv2plug.in/ns/ext/atom>
-- David Robillard <d@drobilla.net>

11
README.md

@ -0,0 +1,11 @@ @@ -0,0 +1,11 @@
Sratom
======
Sratom is a small library for serialising LV2 atoms to and from RDF, for
converting between binary and text or storing in a model. For more
information, see <http://drobilla.net/software/sratom>.
More information about LV2 atoms can be found at
<http://lv2plug.in/ns/ext/atom>
-- David Robillard <d@drobilla.net>

20
doc/footer.html

@ -0,0 +1,20 @@ @@ -0,0 +1,20 @@
<!-- HTML footer for doxygen 1.8.15-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
$navpath
<li class="footer">$generatedby
<a href="http://www.doxygen.org/index.html">Doxygen $doxygenversion</li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<div id="footer">
<address class="footer">$generatedby
<a href="http://www.doxygen.org/">Doxygen</a> $doxygenversion
</address>
</div>
<!--END !GENERATE_TREEVIEW-->
</body>
</html>

37
doc/header.html

@ -0,0 +1,37 @@ @@ -0,0 +1,37 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA-->
<div id="titlearea">
<div id="header">
<div id="titlebox">
<!--BEGIN PROJECT_LOGO-->
<div id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></div>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<h1 id="title">$projectname</h1>
<!--END PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<div id="shortdesc">$projectbrief</div>
<!--END PROJECT_BRIEF-->
</div>
<div id="metabox">
<table id="meta">
<!--BEGIN PROJECT_NUMBER-->
<tr><th>Version</th><td>$projectnumber</td></tr>
<!--END PROJECT_NUMBER-->
</table>
</div>
</div>
</div>
<!--END TITLEAREA-->
<!-- end header part -->

49
doc/layout.xml

@ -1,4 +1,5 @@ @@ -1,4 +1,5 @@
<doxygenlayout version="1.0">
<!-- Generated by doxygen 1.8.15 -->
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
@ -8,17 +9,31 @@ @@ -8,17 +9,31 @@
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="interfaces" visible="yes" title="">
<tab type="interfacelist" visible="yes" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" 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="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="structs" visible="yes" title="">
<tab type="structlist" visible="yes" title="" intro=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
</tab>
<tab type="exceptions" visible="yes" title="">
<tab type="exceptionlist" visible="yes" title="" intro=""/>
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" 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=""/>
<tab type="examples" visible="yes" title="" intro=""/>
</navindex>
<!-- Layout definition for a class page -->
@ -27,10 +42,11 @@ @@ -27,10 +42,11 @@
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<allmemberslink visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<services title=""/>
<interfaces title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
@ -65,6 +81,8 @@ @@ -65,6 +81,8 @@
<inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>
<services title=""/>
<interfaces title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
@ -72,6 +90,7 @@ @@ -72,6 +90,7 @@
<properties title=""/>
<events title=""/>
</memberdef>
<allmemberslink visible="yes"/>
<usedfiles visible="$SHOW_USED_FILES"/>
<authorsection visible="yes"/>
</class>
@ -81,8 +100,14 @@ @@ -81,8 +100,14 @@
<briefdescription visible="yes"/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -92,6 +117,8 @@ @@ -92,6 +117,8 @@
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -107,10 +134,16 @@ @@ -107,10 +134,16 @@
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -121,6 +154,8 @@ @@ -121,6 +154,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -130,9 +165,9 @@ @@ -130,9 +165,9 @@
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="no"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<briefdescription visible="yes"/>
<detaileddescription title=""/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<nestedgroups visible="yes" title=""/>
<dirs visible="yes" title=""/>
@ -141,6 +176,8 @@ @@ -141,6 +176,8 @@
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
@ -159,6 +196,8 @@ @@ -159,6 +196,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>

6
doc/mainpage.md

@ -0,0 +1,6 @@ @@ -0,0 +1,6 @@
Sratom is a small library for serialising [LV2 atoms] to and from RDF, for
converting between binary and text or storing in a model.
The complete API is documented in the [sratom](@ref sratom) group.
[LV2 atoms]: http://lv2plug.in/ns/ext/atom

27
doc/reference.doxygen.in

@ -44,7 +44,7 @@ PROJECT_NUMBER = @SRATOM_VERSION@ @@ -44,7 +44,7 @@ PROJECT_NUMBER = @SRATOM_VERSION@
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
PROJECT_BRIEF = "A lightweight library for RDF storage and serialisation"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
@ -803,7 +803,8 @@ WARN_LOGFILE = @@ -803,7 +803,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @SRATOM_SRCDIR@/sratom/sratom.h
INPUT = @SRATOM_SRCDIR@/sratom/sratom.h \
@SRATOM_SRCDIR@/doc/mainpage.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -870,7 +871,7 @@ EXCLUDE_PATTERNS = @@ -870,7 +871,7 @@ EXCLUDE_PATTERNS =
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
EXCLUDE_SYMBOLS = detail
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include
@ -952,7 +953,7 @@ FILTER_SOURCE_PATTERNS = @@ -952,7 +953,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = @SRATOM_SRCDIR@/doc/mainpage.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
@ -984,7 +985,7 @@ STRIP_CODE_COMMENTS = YES @@ -984,7 +985,7 @@ STRIP_CODE_COMMENTS = YES
# entity all documented functions referencing it will be listed.
# The default value is: NO.
REFERENCED_BY_RELATION = YES
REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
@ -1008,7 +1009,7 @@ REFERENCES_LINK_SOURCE = YES @@ -1008,7 +1009,7 @@ REFERENCES_LINK_SOURCE = YES
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
SOURCE_TOOLTIPS = YES
SOURCE_TOOLTIPS = NO
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
@ -1108,7 +1109,7 @@ HTML_FILE_EXTENSION = .html @@ -1108,7 +1109,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER =
HTML_HEADER = @SRATOM_SRCDIR@/doc/header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1118,7 +1119,7 @@ HTML_HEADER = @@ -1118,7 +1119,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER =
HTML_FOOTER = @SRATOM_SRCDIR@/doc/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1203,7 +1204,7 @@ HTML_TIMESTAMP = NO @@ -1203,7 +1204,7 @@ HTML_TIMESTAMP = NO
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_MENUS = YES
HTML_DYNAMIC_MENUS = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
@ -1423,7 +1424,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project @@ -1423,7 +1424,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = YES
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
@ -2049,7 +2050,7 @@ ENABLE_PREPROCESSING = YES @@ -2049,7 +2050,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
@ -2057,7 +2058,7 @@ MACRO_EXPANSION = NO @@ -2057,7 +2058,7 @@ MACRO_EXPANSION = NO
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
@ -2089,7 +2090,7 @@ INCLUDE_FILE_PATTERNS = @@ -2089,7 +2090,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
PREDEFINED = SRATOM_API
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The

396
doc/style.css

@ -1,68 +1,113 @@ @@ -1,68 +1,113 @@
body {
max-width: 80em;
margin: 0;
background: #FFF;
color: #222;
font-style: normal;
line-height: 1.6em;
margin-left: auto;
margin-right: auto;
background: #FFF;
color: #000;
padding: 1em;
max-width: 60em;
font-family: "DejaVu Serif",Palatino,serif;
text-rendering: optimizeLegibility;
}
#titlearea {
display: none;
h1, .title, #projectname, h2, h3, h4, h5, h6 {
line-height: 1.0125em;
color: #444;
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
margin: 1em 0 0.5em 0;
}
h1, .titlearea .header .titlebox, #projectname {
font-size: 300%;
font-weight: 400;
margin-bottom: 0.25em;
margin-top: 0;
}
h1 {
.header .headertitle .title {
font-size: 180%;
font-weight: 900;
font-weight: 400;
margin: 0.75em 0.25em 0.5em 0;
}
h2 {
font-size: 140%;
font-weight: 700;
.ingroups {
display: inline;
}
.title .ingroups a {
font-size: small;
margin-left: 1em;
}
h3 {
font-size: 120%;
font-weight: 700;
#titlebox, #metabox {
display: inline-block;
}
#titlebox{
display: inline-block;
width: 75%;
left: 0;
top: 0;
}
h4 {
font-size: 110%;
font-weight: 700;
#title {
margin-bottom: 0.25em;
}
h5 {
font-size: 100%;
font-weight: 700;
#shortdesc {
margin: 0;
color: #666;
display: inline-block;
font-style: italic;
padding: 0;
}
h6 {
font-size: 100%;
font-weight: 600;
#titlearea {
margin: 0.25em auto 0.25em auto;
padding: 0;
position: relative;
clear: both;
line-height: 1.0em;
}
p {
margin: 0 0 1em 0;
h2 {
font-size: 160%;
font-weight: 400;
}
dt {
font-weight: 700;
h3 {
font-size: 140%;
font-weight: 400;
}
p.startli,p.startdd,p.starttd {
margin-top: 2px;
h4 {
font-size: 120%;
font-weight: 500;
}
p.endli {
margin-bottom: 0;
h5, h6 {
font-size: 110%;
font-weight: 600;
}
p.enddd {
margin-bottom: 4px;
h1 a, h1 a:link, h1 a:visited ,
h2 a, h2 a:link, h2 a:visited ,
h3 a, h3 a:link, h3 a:visited ,
h4 a, h4 a:link, h4 a:visited ,
h5 a, h5 a:link, h5 a:visited ,
h6 a, h6 a:link, h6 a:visited {
color: #444;
}
p.endtd {
margin-bottom: 2px;
p {
margin: 0.5em 0 0.5em 0;
}
dt {
font-weight: 700;
}
dd {
margin-left: 2em;
}
caption {
@ -115,30 +160,20 @@ code { @@ -115,30 +160,20 @@ code {
color: #444;
}
a.code {
color: #4665A2;
}
a.codeRef {
color: #4665A2;
}
/* @end */
dl.el {
margin-left: -1cm;
}
.fragment {
font-family: monospace, fixed;
font-family: "DejaVu Sans Mono",monospace,fixed;
}
pre.fragment {
border: 1px solid #C4C4C4;
background-color: #F9F9F9;
padding: 4px 6px;
margin: 4px 8px 4px 2px;
padding: 0.5em;
overflow: auto;
line-height: 125%;
}
div.ah {
@ -167,10 +202,11 @@ div.groupText { @@ -167,10 +202,11 @@ div.groupText {
font-style: italic;
}
div.contents {
margin-top: 10px;
margin-left: 10px;
margin-right: 10px;
div.contents, #content {
padding: 0 0.25em 0 0.25em;
max-width: 60em;
margin-left: auto;
margin-right: auto;
}
td.indexkey {
@ -188,6 +224,10 @@ td.indexvalue { @@ -188,6 +224,10 @@ td.indexvalue {
margin: 2px 0;
}
table.memname {
font-family: "DejaVu Sans Mono",monospace,fixed;
}
tr.memlist {
background-color: #EEF1F7;
}
@ -213,7 +253,6 @@ div.center img { @@ -213,7 +253,6 @@ div.center img {
address.footer {
text-align: right;
padding-right: 12px;
}
img.footer {
@ -223,43 +262,31 @@ img.footer { @@ -223,43 +262,31 @@ img.footer {
/* @group Code Colorization */
span.keyword {
color: green;
color: #586E75;
}
span.keywordtype {
color: #3E873E;
color: #546E00;
}
span.keywordflow {
color: #e08000;
color: #586E75;
}
span.comment {
color: maroon;
color: #6C71C4;
}
span.preprocessor {
color: #806020;
color: #D33682;
}
span.stringliteral {
color: #002080;
color: #CB4B16;
}
span.charliteral {
color: teal;
}
span.vhdldigit {
color: #F0F;
}
span.vhdlkeyword {
color: #700070;
}
span.vhdllogic {
color: red;
color: #CB4B16;
}
/* @end */
@ -285,17 +312,20 @@ hr { @@ -285,17 +312,20 @@ hr {
margin: 2em 0 1em;
}
hr.footer {
height: 1px;
#footer {
bottom: 0;
clear: both;
font-size: x-small;
margin: 2em 0 0;
padding: 0 1em 1em 1em;
vertical-align: top;
color: #888;
}
/* @group Member Descriptions */
table.memberdecls {
border-spacing: 0.125em;
}
h2.groupheader {
margin: 0.5em 0 0.25em 0;
line-height: 1.3em;
}
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
@ -309,7 +339,7 @@ h2.groupheader { @@ -309,7 +339,7 @@ h2.groupheader {
.memItemLeft,.memItemRight,.memTemplParams {
border: 0;
font-family: monospace, fixed;
font-family: "DejaVu Sans Mono",monospace,fixed;
}
.memItemLeft,.memTemplItemLeft {
@ -334,7 +364,7 @@ td.memSeparator { @@ -334,7 +364,7 @@ td.memSeparator {
td.mlabels-right {
vertical-align: top;
padding-top: 4px;
color: #AA6;
color: #B4C342;
}
.memtitle {
@ -345,13 +375,15 @@ td.mlabels-right { @@ -345,13 +375,15 @@ td.mlabels-right {
/* @group Member Details */
/* Styles for detailed member documentation */
.memtemplate {
color: #4665A2;
font-weight: bold;
color: #888;
font-style: italic;
font-family: "DejaVu Sans Mono",monospace,fixed;
font-size: small;
}
.memnav {
background-color: #EBEFF6;
border: 1px solid #A3B4D7;
background-color: #EEE;
border: 1px solid #B4C342;
text-align: center;
margin: 2px;
margin-right: 15px;
@ -359,23 +391,25 @@ td.mlabels-right { @@ -359,23 +391,25 @@ td.mlabels-right {
}
.memitem {
padding: 0;
margin: 1em 0 1em 0;
padding: 0.25em 0.5em 0.25em 0.5em;
margin: 0 0 1em 0;
border-radius: 6px;
border: 1px solid #DDD;
}
.memproto {
padding: 0;
font-weight: bold;
color: #000;
font-size: 110%;
font-weight: 400;
line-height: 1em;
color: #000;
}
.memproto .paramname {
color: #444;
font-style: normal;
}
.memdoc {
padding: 0 0 0.5em 2em;
padding: 0 0.25em 0 0.25em;
}
.paramkey {
@ -383,37 +417,54 @@ td.mlabels-right { @@ -383,37 +417,54 @@ td.mlabels-right {
}
.paramtype {
color: #3E873E;
color: #666;
padding-right: 0.5em;
white-space: nowrap;
}
.paramname {
color: #444;
color: #111;
white-space: nowrap;
font-weight: bold;
}
td.paramname {
vertical-align: top;
font-family: "DejaVu Sans Mono",monospace,fixed;
font-style: italic;
padding-right: 0.5em;
}
.fieldname {
color: #000;
}
.fieldtable {
padding-top: 0.25em;
border-top: 1px dashed #DDD;
}
.fieldtable tbody tr:first-child {
display: none;
}
td.fieldname {
padding-right: 1em;
padding: 0 0.5em 0 0.25em;
vertical-align: top;
font-family: "DejaVu Sans Mono",monospace,fixed;
}
td.fieldtype {
color: #666;
padding: 0 0.5em 0 0;
vertical-align: top;
color: #444;
padding-right: 0.5em;
font-family: "DejaVu Sans Mono",monospace,fixed;
}
td.fielddoc p {
margin: 0;
vertical-align: top;
padding: 0 0.5em 0 0;
}
p.reference {
font-size: x-small;
font-style: italic;
}
/* @end */
@ -454,6 +505,22 @@ td.fielddoc p { @@ -454,6 +505,22 @@ td.fielddoc p {
vertical-align: -30%;
}
td.entry {
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
font-weight: 400;
padding-right: 1em;
}
td.entry .arrow {
display: none;
}
td.entry b {
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
font-weight: 400;
font-size: 130%;
}
/* these are for tree view when not used as main index */
.directory-alt {
font-size: 100%;
@ -491,7 +558,7 @@ div.dynheader { @@ -491,7 +558,7 @@ div.dynheader {
address {
font-style: normal;
color: #2A3D61;
color: #444;
}
table.doxtable {
@ -523,23 +590,20 @@ table.doxtable th { @@ -523,23 +590,20 @@ table.doxtable th {
}
div.navpath {
padding: 0.25em;
color: #DDD;
}
.navpath ul {
font-size: x-small;
color: #8AA0CC;
overflow: hidden;
margin: 0;
padding: 0;
}
.navpath li {
list-style-type: none;
float: left;
padding-left: 10px;
padding-right: 15px;
color: #364D7C;
padding-left: 0;
margin-left: 0.5em;
padding-right: 1em;
}
.navpath a {
@ -548,62 +612,68 @@ div.navpath { @@ -548,62 +612,68 @@ div.navpath {
outline: none;
}
.navpath a:hover {
color: #6884BD;
}
div.summary {
float: right;
font-size: x-small;
padding: 0.25em 0.5em 0 0;
width: 50%;
text-align: right;
font-size: small;
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
margin: 0;
color: #FFF; /* Hide separator bars */
border-bottom: 1px solid #DDD;
padding: 0.25em 0;
}
div.summary a {
white-space: nowrap;
}
div.header {
background-color: #F3F3F3;
margin: 0;
/* Metadata box (right aligned next to title) */
#metabox {
display: inline-block;
font-size: x-small;
margin: 0 0 0.25em 0;
position: absolute;
right: 0;
top: 0;
color: #666;
font-style: italic;
padding: 0 1em;
}
#meta {
border-style: hidden;
margin-right: 0.25em;
}
#meta tr, #meta th, #meta td {
background-color: transparent;
border: 0;
margin: 0;
font-weight: normal;
}
div.headertitle {
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, #333 0%, #111 100%);
border: solid 1px #444;
border-top: 0;
border-radius: 0 0 6px 6px;
#meta th {
text-align: right;
}
#meta th:after {
content: ":";
}
div.line {
font-family: monospace, fixed;
font-size: 13px;
min-height: 13px;
line-height: 1.0;
text-wrap: avoid;
font-family: "DejaVu Sans Mono",monospace,fixed;
line-height: 1.4em;
white-space: pre-wrap;
text-indent: -53px;
padding-left: 53px;
padding-bottom: 0;
margin: 0;
}
.glow {
background-color: cyan;
box-shadow: 0 0 10px cyan;
background-color: #2AA198;
box-shadow: 0 0 10px #2AA198;
}
span.lineno {
padding-right: 4px;
text-align: right;
border-right: 2px solid #0F0;
border-right: 2px solid #546E00;
background-color: #E8E8E8;
white-space: pre;
}
@ -616,22 +686,17 @@ span.lineno a:hover { @@ -616,22 +686,17 @@ span.lineno a:hover {
}
.tabs, .tabs2, .navpath {
background-image: none;
background-color: #333;
background: linear-gradient(to bottom, #333 0%, #111 100%);
border: 0;
border-bottom: solid 2px #000;
padding: 0;
padding-top: 2px;
font-size: small;
}
#navrow1 {
border: 0;
padding: 0.25em 0;
border-bottom: 1px solid #DDD;
font-size: small;
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
margin: 0;
}
th {
text-align: left;
font-size: 110%;
font-weight: 500;
}
.mlabel {
@ -650,40 +715,23 @@ th { @@ -650,40 +715,23 @@ th {
display: table-cell;
line-height: 2em;
list-style: none;
background-color: #333;
background: linear-gradient(to bottom, #444 0%, #222 100%);
border: 1px solid #222;
border-bottom: 0;
border-radius: 6px 6px 0 0;
color: #DDD;
}
.tablist a {
display: block;
padding: 0 20px;
font-weight: bold;
color: #859900;
padding: 0 1em 0 0;
font-family: "DejaVu Sans",Helvetica,Arial,sans-serif;
text-decoration: none;
outline: none;
}
.header a {
color: #859900;
}
.tabs3 .tablist a {
padding: 0 10px;
}
.tablist a:hover {
color: #fff;
text-shadow: 0 1px 1px rgba(0, 0, 0, 1.0);
text-decoration: none;
}
.tablist li.current a {
color: #fff;
text-shadow: 0 1px 1px rgba(0, 0, 0, 1.0);
color: #222;
}
span.icon {

6
wscript

@ -136,8 +136,6 @@ def build(bld): @@ -136,8 +136,6 @@ def build(bld):
autowaf.build_dox(bld, 'SRATOM', SRATOM_VERSION, top, out)
bld.add_post_fun(autowaf.run_ldconfig)
if bld.env.DOCS:
bld.add_post_fun(fix_docs)
def test(tst):
tst(['./sratom_test'])
@ -154,10 +152,6 @@ def lint(ctx): @@ -154,10 +152,6 @@ def lint(ctx):
"$(find .. -name '*.c')")
subprocess.call(cmd, cwd='build', shell=True)
def fix_docs(ctx):
if ctx.cmd == 'build':
autowaf.make_simple_dox(APPNAME)
def upload_docs(ctx):
os.system("rsync -ravz --delete -e ssh build/doc/html/ drobilla@drobilla.net:~/drobilla.net/docs/sratom/")

Loading…
Cancel
Save