aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/doc
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2020-10-01 19:07:01 +0200
committerHanspeter Portner <dev@open-music-kontrollers.ch>2020-10-01 19:07:01 +0200
commitfce27b95f66c72ae4125395762379b25a527a10f (patch)
tree00688b487863d55976adbae35be4e56776f65328 /subprojects/d2tk/pugl/doc
parent61a7fdc8a804342b541b0ca71cc026be1c980255 (diff)
parent64720df0d51248d35a8df7d6e844eb42736d7805 (diff)
downloadmephisto.lv2-fce27b95f66c72ae4125395762379b25a527a10f.tar.xz
Merge commit '64720df0d51248d35a8df7d6e844eb42736d7805' into master
Diffstat (limited to 'subprojects/d2tk/pugl/doc')
-rw-r--r--subprojects/d2tk/pugl/doc/layout.xml3
-rw-r--r--subprojects/d2tk/pugl/doc/mainpage.md4
-rw-r--r--subprojects/d2tk/pugl/doc/reference.doxygen.in28
-rw-r--r--subprojects/d2tk/pugl/doc/style.css73
4 files changed, 79 insertions, 29 deletions
diff --git a/subprojects/d2tk/pugl/doc/layout.xml b/subprojects/d2tk/pugl/doc/layout.xml
index 1889302..2995c0e 100644
--- a/subprojects/d2tk/pugl/doc/layout.xml
+++ b/subprojects/d2tk/pugl/doc/layout.xml
@@ -25,6 +25,7 @@
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
+ <detaileddescription title=""/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
@@ -107,6 +108,7 @@
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
+ <detaileddescription title=""/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<includegraph visible="$INCLUDE_GRAPH"/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
@@ -122,7 +124,6 @@
<variables title=""/>
<membergroups visible="yes"/>
</memberdecl>
- <detaileddescription title=""/>
<memberdef>
<inlineclasses title=""/>
<defines title=""/>
diff --git a/subprojects/d2tk/pugl/doc/mainpage.md b/subprojects/d2tk/pugl/doc/mainpage.md
index aa6f925..c04bf9e 100644
--- a/subprojects/d2tk/pugl/doc/mainpage.md
+++ b/subprojects/d2tk/pugl/doc/mainpage.md
@@ -1,6 +1,6 @@
This is the API documentation for Pugl.
-This documentation is based around the [C API](@ref pugl_api),
-there is also a [C++ API](@ref pugl) in the `pugl` namespace.
+This page refers to the [C API](@ref pugl_c),
+there is also a [C++ API](@ref pugl_cxx) in the `pugl` namespace.
The Pugl API revolves around two main objects:
the [World](@ref world) and the [View](@ref view).
diff --git a/subprojects/d2tk/pugl/doc/reference.doxygen.in b/subprojects/d2tk/pugl/doc/reference.doxygen.in
index 1357fe4..4e91ca2 100644
--- a/subprojects/d2tk/pugl/doc/reference.doxygen.in
+++ b/subprojects/d2tk/pugl/doc/reference.doxygen.in
@@ -243,12 +243,6 @@ TAB_SIZE = 4
ALIASES =
-# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding "class=itcl::class"
-# will allow you to use the command class in the itcl::class meaning.
-
-TCL_SUBST =
-
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
@@ -447,7 +441,7 @@ LOOKUP_CACHE_SIZE = 0
# normally produced when WARNINGS is set to YES.
# The default value is: NO.
-EXTRACT_ALL = YES
+EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
@@ -498,7 +492,7 @@ EXTRACT_ANON_NSPACES = NO
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
-HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
@@ -506,7 +500,7 @@ HIDE_UNDOC_MEMBERS = YES
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
-HIDE_UNDOC_CLASSES = YES
+HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
@@ -543,7 +537,7 @@ CASE_SENSE_NAMES = YES
# scope will be hidden.
# The default value is: NO.
-HIDE_SCOPE_NAMES = NO
+HIDE_SCOPE_NAMES = YES
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
# append additional text to a page's title, such as Class Reference. If set to
@@ -752,7 +746,7 @@ WARNINGS = YES
# will automatically be disabled.
# The default value is: YES.
-WARN_IF_UNDOCUMENTED = YES
+WARN_IF_UNDOCUMENTED = NO
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
@@ -769,7 +763,7 @@ WARN_IF_DOC_ERROR = YES
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
# The default value is: NO.
-WARN_NO_PARAMDOC = YES
+WARN_NO_PARAMDOC = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
@@ -1165,7 +1159,7 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_HUE = 160
+HTML_COLORSTYLE_HUE = 120
# 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
@@ -1173,7 +1167,7 @@ HTML_COLORSTYLE_HUE = 160
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_COLORSTYLE_SAT = 100
+HTML_COLORSTYLE_SAT = 32
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
@@ -1685,7 +1679,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
-PAPER_TYPE = a4wide
+PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@@ -1930,7 +1924,7 @@ MAN_LINKS = NO
# captures the structure of the code including all documentation.
# The default value is: NO.
-GENERATE_XML = NO
+GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2090,7 +2084,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 = PUGL_API PUGL_DISABLE_DEPRECATED
+PREDEFINED = PUGL_API PUGL_DISABLE_DEPRECATED PUGL_CONST_FUNC=
# 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
diff --git a/subprojects/d2tk/pugl/doc/style.css b/subprojects/d2tk/pugl/doc/style.css
index 28f0519..680fe77 100644
--- a/subprojects/d2tk/pugl/doc/style.css
+++ b/subprojects/d2tk/pugl/doc/style.css
@@ -233,6 +233,14 @@ div.groupHeader {
font-weight: 700;
}
+h2.groupheader {
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
+}
+
a + h2.groupheader {
display: none;
}
@@ -387,6 +395,18 @@ table.memberdecls {
line-height: 1.3em;
}
+table.memberdecls h3 {
+ line-height: 1.18em;
+ font-size: 1em;
+ font-weight: 600;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ margin: 1.25em 0 0.5em 0;
+}
+
+tr.inherit_header td {
+ padding: 1em 0 0.5em 0;
+}
+
.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams {
margin: 0;
padding: 0;
@@ -419,13 +439,28 @@ td.memSeparator {
display: none;
}
+td.mlabels-left {
+ margin-left: 0;
+ padding-left: 0;
+}
+
td.mlabels-right {
- vertical-align: top;
- padding-top: 4px;
color: #B4C342;
+ font-weight: normal;
+ margin-left: 1em;
+ vertical-align: bottom;
}
.memtitle {
+ border-bottom: 1px solid #EEE;
+ font-family: Helvetica, Arial, "DejaVu Sans Condensed", Verdana, sans-serif;
+ font-size: 1.18em;
+ font-weight: 600;
+ line-height: 1.41em;
+ margin: 1.5em 0 0 0;
+}
+
+.permalink {
display: none;
}
@@ -446,18 +481,20 @@ td.mlabels-right {
}
.memitem {
- padding: 0.5em 0.5em 0.25em 0.5em;
- margin: 1em 0 2em 0;
+ padding: 0;
+ margin: 0 0 3em 0;
}
.memproto {
border-bottom: 1px solid #EEE;
+ border-left: 1px solid #EEE;
+ color: #444;
+ float: right;
font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
- font-size: 1.09em;
- font-weight: 600;
- line-height: 1.41em;
- margin-bottom: 0.25em;
- padding-bottom: 0.125em;
+ font-size: small;
+ margin-bottom: 1em;
+ margin-left: 1em;
+ padding: 0.25em 0 0.25em 0.25em;
}
.memproto .paramname {
@@ -465,6 +502,11 @@ td.mlabels-right {
padding-right: 0.25em;
}
+.mlabels {
+ padding-left: 0;
+ padding-right: 0;
+}
+
.memdoc {
padding: 0;
}
@@ -473,6 +515,19 @@ td.mlabels-right {
font-style: italic;
color: #444;
margin-bottom: 0.75em;
+ margin-top: 0;
+ padding-top: 0.25em;
+ font-weight: normal;
+}
+
+.memdoc > p:first-child, .memdoc .textblock > h3:first-child {
+ color: #444;
+ margin-bottom: 0.75em;
+ margin-top: 0;
+ padding-top: 0.25em;
+ font-weight: normal;
+ color: #444;
+ font-size: 0.9em;
}
.paramkey {