diff options
| author | David Robillard <d@drobilla.net> | 2019-03-24 21:52:12 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2019-03-24 21:52:36 +0100 |
| commit | 03b6f8d9f3c750b9e1cc1b6b6f57aa7d16430a4c (patch) | |
| tree | 26606c9fc4c6a97ffcd7da822e51479103c4fedb | |
| parent | 934ddd6669efae6ae1287b8fb5dbb5bd3724b59f (diff) | |
| download | lv2-03b6f8d9f3c750b9e1cc1b6b6f57aa7d16430a4c.tar.xz | |
Clean up API documentation main page
| -rw-r--r-- | doc/mainpage.dox | 21 | ||||
| -rw-r--r-- | doc/mainpage.md | 3 | ||||
| -rw-r--r-- | doc/reference.doxygen.in | 4 |
3 files changed, 5 insertions, 23 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox deleted file mode 100644 index 920ef1d..0000000 --- a/doc/mainpage.dox +++ /dev/null @@ -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 - diff --git a/doc/mainpage.md b/doc/mainpage.md new file mode 100644 index 0000000..561bc93 --- /dev/null +++ b/doc/mainpage.md @@ -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). diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index cbf3135..77a67b4 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -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 = # (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 |