aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/c/doxy-style.css4
-rw-r--r--doc/c/layout.xml58
-rw-r--r--doc/c/meson.build6
-rw-r--r--doc/c/reference.doxygen.in174
-rw-r--r--doc/index.html.in1
-rw-r--r--doc/ns/ext/meson.build3
-rw-r--r--doc/ns/extensions/meson.build3
-rw-r--r--doc/ns/meson.build11
-rw-r--r--doc/style/meson.build7
9 files changed, 21 insertions, 246 deletions
diff --git a/doc/c/doxy-style.css b/doc/c/doxy-style.css
index b44675e..6f15ee4 100644
--- a/doc/c/doxy-style.css
+++ b/doc/c/doxy-style.css
@@ -208,6 +208,10 @@ dl.el {
font-family: "SF Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace, fixed;
}
+.ttc {
+ display: none;
+}
+
pre.fragment {
border: 1px solid #C4C4C4;
background-color: #F9F9F9;
diff --git a/doc/c/layout.xml b/doc/c/layout.xml
index 1f63a76..938dbce 100644
--- a/doc/c/layout.xml
+++ b/doc/c/layout.xml
@@ -9,26 +9,12 @@
<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="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=""/>
@@ -47,7 +33,6 @@
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<services title=""/>
- <interfaces title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
@@ -82,7 +67,6 @@
<typedefs title=""/>
<enums title=""/>
<services title=""/>
- <interfaces title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
@@ -95,37 +79,6 @@
<authorsection visible="yes"/>
</class>
- <!-- Layout definition for a namespace page -->
- <namespace>
- <briefdescription visible="yes"/>
- <detaileddescription title=""/>
- <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=""/>
- <membergroups visible="yes"/>
- </memberdecl>
- <memberdef>
- <inlineclasses title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <functions title=""/>
- <variables title=""/>
- </memberdef>
- <authorsection visible="yes"/>
- </namespace>
-
<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
@@ -135,16 +88,11 @@
<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=""/>
@@ -154,8 +102,6 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@@ -176,8 +122,6 @@
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
@@ -196,8 +140,6 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
diff --git a/doc/c/meson.build b/doc/c/meson.build
index 3ce7fdc..da88b86 100644
--- a/doc/c/meson.build
+++ b/doc/c/meson.build
@@ -1,5 +1,5 @@
# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
+# SPDX-License-Identifier: 0BSD OR ISC
lv2_source_doc = meson.current_source_dir()
@@ -11,7 +11,7 @@ if doxygen.found()
'LV2_SRCDIR': lv2_source_root,
'LV2_BUILDDIR': lv2_build_root,
'LV2_VERSION': meson.project_version(),
- }
+ },
)
reference_doxygen = configure_file(
@@ -25,7 +25,7 @@ if doxygen.found()
command: [doxygen, '@INPUT@'],
input: reference_doxygen,
install: true,
- install_dir: lv2_docdir,
+ install_dir: lv2_docdir / 'c',
output: ['html', 'tags'],
)
diff --git a/doc/c/reference.doxygen.in b/doc/c/reference.doxygen.in
index 83589fe..333fe1c 100644
--- a/doc/c/reference.doxygen.in
+++ b/doc/c/reference.doxygen.in
@@ -179,16 +179,6 @@ SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
-# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
-# such as
-# /***************
-# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
-# Javadoc-style will behave just like regular comments and it will not be
-# interpreted by doxygen.
-# The default value is: NO.
-
-JAVADOC_BANNER = NO
-
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
@@ -209,14 +199,6 @@ QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
-# By default Python docstrings are displayed as preformatted text and doxygen's
-# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
-# doxygen's special commands can be used and the contents of the docstring
-# documentation blocks is shown as doxygen documentation.
-# The default value is: YES.
-
-PYTHON_DOCSTRING = YES
-
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
@@ -281,14 +263,6 @@ OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
-# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
-# sources only. Doxygen will then generate output that is more tailored for that
-# language. For instance, namespaces will be presented as modules, types will be
-# separated into more groups, etc.
-# The default value is: NO.
-
-OPTIMIZE_OUTPUT_SLICE = NO
-
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
@@ -442,19 +416,6 @@ TYPEDEF_HIDES_STRUCT = YES
LOOKUP_CACHE_SIZE = 0
-# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
-# during processing. When set to 0 doxygen will based this on the number of
-# cores available in the system. You can set it explicitly to a value larger
-# than 0 to get more control over the balance between CPU load and processing
-# speed. At this moment only the input processing can be done using multiple
-# threads. Since this is still an experimental feature the default is set to 1,
-# which effectively disables parallel processing. Please report any issues you
-# encounter. Generating dot graphs in parallel is controlled by the
-# DOT_NUM_THREADS setting.
-# Minimum value: 0, maximum value: 32, default value: 1.
-
-NUM_PROC_THREADS = 1
-
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
@@ -475,12 +436,6 @@ EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES
-# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
-# methods of a class will be included in the documentation.
-# The default value is: NO.
-
-EXTRACT_PRIV_VIRTUAL = NO
-
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
@@ -518,13 +473,6 @@ EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
-# If this flag is set to YES, the name of an unnamed parameter in a declaration
-# will be determined by the corresponding definition. By default unnamed
-# parameters remain unnamed in the output.
-# The default value is: YES.
-
-RESOLVE_UNNAMED_PARAMS = YES
-
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
@@ -857,6 +805,7 @@ INPUT = @LV2_SRCDIR@/doc/c/mainpage.md \
@LV2_SRCDIR@/include/lv2/atom/util.h \
@LV2_SRCDIR@/include/lv2/buf-size/buf-size.h \
@LV2_SRCDIR@/include/lv2/core/lv2.h \
+ @LV2_SRCDIR@/include/lv2/core/lv2_util.h \
@LV2_SRCDIR@/include/lv2/data-access/data-access.h \
@LV2_SRCDIR@/include/lv2/dynmanifest/dynmanifest.h \
@LV2_SRCDIR@/include/lv2/event/event-helpers.h \
@@ -1258,15 +1207,6 @@ HTML_COLORSTYLE_SAT = 30
HTML_COLORSTYLE_GAMMA = 100
-# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
-# page will contain the date and time when the page was generated. Setting this
-# to YES can help to show when doxygen was last run and thus if the
-# documentation is up to date.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_TIMESTAMP = NO
-
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
# are dynamically created via JavaScript. If disabled, the navigation index will
@@ -1545,17 +1485,6 @@ TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
-# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
-# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
-# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
-# the HTML output. These images will generally look nicer at scaled resolutions.
-# Possible values are: png (the default) and svg (looks nicer but requires the
-# pdf2svg or inkscape tool).
-# The default value is: png.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_FORMULA_FORMAT = png
-
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
@@ -1565,23 +1494,6 @@ HTML_FORMULA_FORMAT = png
FORMULA_FONTSIZE = 10
-# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
-# generated for formulas are transparent PNGs. Transparent PNGs are not
-# supported properly for IE 6.0, but are supported on all modern browsers.
-#
-# Note that when changing this option you need to delete any form_*.png files in
-# the HTML output directory before the changes have effect.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FORMULA_TRANSPARENT = YES
-
-# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
-# to create new LaTeX commands to be used in formulas as building blocks. See
-# the section "Including formulas" for details.
-
-FORMULA_MACROFILE =
-
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
# https://www.mathjax.org) which uses client side JavaScript for the rendering
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
@@ -1772,16 +1684,6 @@ LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
-# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
-# generate index for LaTeX. In case there is no backslash (\) as first character
-# it will be automatically added in the LaTeX code.
-# Note: This tag is used in the generated output file (.tex).
-# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
-# The default value is: makeindex.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_MAKEINDEX_CMD = makeindex
-
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
@@ -1901,22 +1803,6 @@ LATEX_HIDE_INDICES = NO
LATEX_BIB_STYLE = plain
-# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
-# page will contain the date and time when the page was generated. Setting this
-# to NO can help when comparing the output of multiple runs.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_TIMESTAMP = NO
-
-# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
-# path from which the emoji images will be read. If a relative path is entered,
-# it will be relative to the LATEX_OUTPUT directory. If left blank the
-# LATEX_OUTPUT directory will be used.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_EMOJI_DIRECTORY =
-
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
@@ -2044,13 +1930,6 @@ XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
-# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
-# namespace members in file scope as well, matching the HTML output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_NS_MEMB_FILE_SCOPE = NO
-
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
@@ -2279,23 +2158,6 @@ HAVE_DOT = NO
DOT_NUM_THREADS = 0
-# When you want a differently looking font in the dot files that doxygen
-# generates you can specify the font name using DOT_FONTNAME. You need to make
-# sure dot is able to find the font, which can be done by putting it in a
-# standard location or by setting the DOTFONTPATH environment variable or by
-# setting DOT_FONTPATH to the directory containing the font.
-# The default value is: Helvetica.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTNAME =
-
-# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
-# dot graphs.
-# Minimum value: 4, maximum value: 24, default value: 10.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTSIZE = 10
-
# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
@@ -2351,28 +2213,6 @@ UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
-# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
-# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
-# tag is set to YES, doxygen will add type and arguments for attributes and
-# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
-# will not generate fields with class member information in the UML graphs. The
-# class diagrams will look similar to the default class diagrams but using UML
-# notation for the relationships.
-# Possible values are: NO, YES and NONE.
-# The default value is: NO.
-# This tag requires that the tag UML_LOOK is set to YES.
-
-DOT_UML_DETAILS = NO
-
-# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
-# to display on a single line. If the actual line length exceeds this threshold
-# significantly it will wrapped across multiple lines. Some heuristics are apply
-# to avoid ugly line breaks.
-# Minimum value: 0, maximum value: 1000, default value: 17.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_WRAP_THRESHOLD = 17
-
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
@@ -2533,18 +2373,6 @@ DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
-# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
-# background. This is disabled by default, because dot on Windows does not seem
-# to support this out of the box.
-#
-# Warning: Depending on the platform used, enabling this option may lead to
-# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
-# read).
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_TRANSPARENT = NO
-
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
diff --git a/doc/index.html.in b/doc/index.html.in
index 6f3e0f9..3be99f4 100644
--- a/doc/index.html.in
+++ b/doc/index.html.in
@@ -19,7 +19,6 @@
<div id="metabox">
<table id="meta">
<tr><th>Version</th><td>@LV2_VERSION@</td></tr>
- <tr><th>Date</th><td>@DATE@</td></tr>
<tr><th>Discuss</th>
<td>
<a href="mailto:devel@lists.lv2plug.in">devel@lists.lv2plug.in</a>
diff --git a/doc/ns/ext/meson.build b/doc/ns/ext/meson.build
index f6ad06b..bf6431b 100644
--- a/doc/ns/ext/meson.build
+++ b/doc/ns/ext/meson.build
@@ -1,5 +1,5 @@
# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
+# SPDX-License-Identifier: 0BSD OR ISC
config = configuration_data({'BASE': '/ns/ext'})
@@ -45,6 +45,7 @@ if build_docs
command: lv2specgen_command_prefix + [
'--docdir=../../c/html',
'--style-uri=../../style/style.css',
+ ] + [
'@INPUT@',
'@OUTPUT@',
],
diff --git a/doc/ns/extensions/meson.build b/doc/ns/extensions/meson.build
index 5a25184..837f736 100644
--- a/doc/ns/extensions/meson.build
+++ b/doc/ns/extensions/meson.build
@@ -1,5 +1,5 @@
# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
+# SPDX-License-Identifier: 0BSD OR ISC
config = configuration_data({'BASE': '/ns/extensions'})
@@ -26,6 +26,7 @@ if build_docs
command: lv2specgen_command_prefix + [
'--docdir=../../c/html',
'--style-uri=../../style/style.css',
+ ] + [
'@INPUT@',
'@OUTPUT@',
],
diff --git a/doc/ns/meson.build b/doc/ns/meson.build
index aa41464..126a100 100644
--- a/doc/ns/meson.build
+++ b/doc/ns/meson.build
@@ -1,5 +1,5 @@
# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
+# SPDX-License-Identifier: 0BSD OR ISC
config = configuration_data({'BASE': '/ns'})
@@ -24,6 +24,7 @@ if build_docs
command: lv2specgen_command_prefix + [
'--docdir=../c/html',
'--style-uri=../style/style.css',
+ ] + [
'@INPUT@',
'@OUTPUT@',
],
@@ -55,12 +56,14 @@ subdir('extensions')
# Index #
#########
-lv2_build_index = find_program(lv2_source_root / 'scripts' / 'lv2_build_index.py')
+lv2_build_index = find_program(
+ lv2_source_root / 'scripts' / 'lv2_build_index.py',
+)
lv2_build_index_command = [
lv2_build_index,
- '--lv2-version', meson.project_version(),
- '--lv2-source-root', lv2_source_root,
+ ['--lv2-version', meson.project_version()],
+ ['--lv2-source-root', lv2_source_root],
]
if get_option('online_docs')
diff --git a/doc/style/meson.build b/doc/style/meson.build
index 7ae9a04..39e9242 100644
--- a/doc/style/meson.build
+++ b/doc/style/meson.build
@@ -1,10 +1,7 @@
# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
+# SPDX-License-Identifier: 0BSD OR ISC
-style_files = files(
- 'pygments.css',
- 'style.css'
-)
+style_files = files('pygments.css', 'style.css')
foreach file : style_files
configure_file(