summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/mainpage.dox20
-rw-r--r--doc/reference.doxygen.in7
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 8417a4a..dd5b986 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -3,7 +3,25 @@
@section Overview
SLV2 is a host library to simplify the discovery, loading, and use of LV2
-plugins.
+plugins (http://lv2plug.in).
+SLV2 is written in standard C99, and depends only on the Redland RDF library
+(http://librdf.org). It should be portable to any system, and is tested on various
+GNU/Linux distributions (often), and Mac OSX (occasionally).
+
+The public interface of SLV2 is documented in several sections. The RDF and shared
+library functionality is strictly divided so it is simple to understand when each is
+being used (e.g. it is possible to discover/investigate plugins and related data
+without loading any shared libraries, avoiding the associated risks).
+
+\li \link world World \endlink - Global library initialisation, state, plugin discovery, etc.
+
+\li \link util Util \endlink - Generally useful utility functions
+
+\li \link collections Collections \endlink - Collections of values (literals and URIs) and objects
+
+\li \link data Data \endlink - Access to plugin RDF data
+
+\li \link lib Library \endlink - Access to plugin shared libraries
*/
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 584fb89..c08f4a1 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -38,7 +38,7 @@ PROJECT_NUMBER = @PACKAGE_VERSION@
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = @abs_top_builddir@/doc
+OUTPUT_DIRECTORY = @abs_top_builddir@/doc/slv2
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -474,7 +474,10 @@ INPUT = @abs_srcdir@/../doc/mainpage.dox \
@abs_srcdir@/../slv2/pluginclasses.h \
@abs_srcdir@/../slv2/plugininstance.h \
@abs_srcdir@/../slv2/plugins.h \
- @abs_srcdir@/../slv2/port.h
+ @abs_srcdir@/../slv2/port.h \
+ @abs_srcdir@/../slv2/pluginui.h \
+ @abs_srcdir@/../slv2/pluginuis.h \
+ @abs_srcdir@/../slv2/pluginuiinstance.h
# This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default