Browse Source

Clean up API documentation main page

zrythm_meson
David Robillard 3 years ago
parent
commit
03b6f8d9f3
  1. 21
      doc/mainpage.dox
  2. 3
      doc/mainpage.md
  3. 4
      doc/reference.doxygen.in

21
doc/mainpage.dox

@ -1,21 +0,0 @@ @@ -1,21 +0,0 @@
/** @mainpage
*
* This is the documentation for the LV2 specification and its
* official extensions.
*
* An LV2 extension generally has two parts: the specification in
* <a href="http://www.w3.org/TeamSubmission/turtle/">Turtle</a>
* (e.g. ext.lv2/ext.ttl), and an accompanying
* <a href="http://en.wikipedia.org/wiki/C99">C</a> header (e.g. ext.lv2/ext.h).
* The header documentation is generated with <a href="http://doxygen.org">
* Doxygen</a> and hyperlinked (in both directions) with the specification
* documentation generated from Turtle with
* <a href="http://drobilla.net/software/lv2specgen">lv2specgen</a>.
*
* \li <a href="../../ns/index.html">LV2 Specifications</a>
* \li <a href="annotated.html">Data Structures</a>
* \li <a href="files.html">Headers</a>
*/
#define NOTHING_HERE

3
doc/mainpage.md

@ -0,0 +1,3 @@ @@ -0,0 +1,3 @@
This is the API documentation for LV2.
For an index and higher level documentation, see the corresponding [specification documentation](../../ns/index.html).

4
doc/reference.doxygen.in

@ -803,7 +803,7 @@ WARN_LOGFILE = @@ -803,7 +803,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = @LV2_SRCDIR@/doc/mainpage.dox \
INPUT = @LV2_SRCDIR@/doc/mainpage.md \
@LV2_SRCDIR@/lv2/atom/atom.h \
@LV2_SRCDIR@/lv2/atom/forge.h \
@LV2_SRCDIR@/lv2/atom/util.h \
@ -980,7 +980,7 @@ FILTER_SOURCE_PATTERNS = @@ -980,7 +980,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 = @LV2_SRCDIR@/doc/mainpage.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing

Loading…
Cancel
Save