summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am14
-rw-r--r--doc/mainpage.dox83
-rw-r--r--doc/reference.doxygen.in39
3 files changed, 89 insertions, 47 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 8b64001..50532ed 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,7 +1,15 @@
-EXTRA_DIST = mainpage.dox reference.doxygen
+EXTRA_DIST = mainpage.dox man.dox html.dox reference.doxygen
-all-local: doc
+man_MANS = \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2.3 \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2_collections.3 \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2_data.3 \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2_library.3 \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2_util.3 \
+ @abs_top_builddir@/doc/slv2/man/man3/slv2_world.3
-doc: $(srcdir)/reference.doxygen.in reference.doxygen $(srcdir)/../slv2/*.h
+all-local: docs
+
+docs: $(srcdir)/reference.doxygen.in reference.doxygen $(srcdir)/../slv2/*.h
mkdir -p @abs_top_builddir@/doc/slv2
doxygen reference.doxygen
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index dd5b986..6f0a37a 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -1,27 +1,60 @@
-/** @mainpage
-
-@section Overview
-
-SLV2 is a host library to simplify the discovery, loading, and use of LV2
-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).
+/* This duplication sucks :( */
-\li \link world World \endlink - Global library initialisation, state, plugin discovery, etc.
+/* HTML */
-\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
-
-*/
+/** @mainpage
+ * @section Overview
+ *
+ * SLV2 is a host library to simplify the discovery, loading, and use of LV2
+ * 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 with Redland, and
+ * is tested on various GNU/Linux distributions (often), and MacOS X (occasionally).
+ *
+ * The Data (RDF) and code (shared library) functionality in SLV2 is strictly
+ * separated so it is simple to control where each is used (e.g. it is
+ * possible to discover/investigate plugins and related data without loading
+ * any shared libraries, avoiding the associated risks).
+ *
+ * The SLV2 documentation is broken into several pages:
+ *
+ * \li \link slv2_world slv2_world \endlink - Global library initialisation, state, plugin discovery, etc.
+ *
+ * \li \link slv2_util slv2_util \endlink - Generally useful utility functions
+ *
+ * \li \link slv2_collections slv2_collections \endlink - Collections of values (literals and URIs) and objects
+ *
+ * \li \link slv2_data slv2_data \endlink - Access to plugin RDF data
+ *
+ * \li \link slv2_library slv2_library \endlink - Access to plugin shared libraries
+ */
+
+
+/* man page */
+
+/** @defgroup slv2 SLV2
+ * SLV2 is a host library to simplify the discovery, loading, and use of LV2
+ * 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 with Redland, and
+ * is tested on various GNU/Linux distributions (often), and MacOS X (occasionally).
+ *
+ * The Data (RDF) and code (shared library) functionality in SLV2 is strictly
+ * separated so it is simple to control where each is used (e.g. it is
+ * possible to discover/investigate plugins and related data without loading
+ * any shared libraries, avoiding the associated risks).
+ *
+ * The SLV2 documentation is broken into several pages:
+ *
+ * \li \link slv2_world slv2_world \endlink - Global library initialisation, state, plugin discovery, etc.
+ *
+ * \li \link slv2_util slv2_util \endlink - Generally useful utility functions
+ *
+ * \li \link slv2_collections slv2_collections \endlink - Collections of values (literals and URIs) and objects
+ *
+ * \li \link slv2_data slv2_data \endlink - Access to plugin RDF data
+ *
+ * \li \link slv2_library slv2_library \endlink - Access to plugin shared libraries
+ */
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 34fa7ca..b7fbe90 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/slv2
+OUTPUT_DIRECTORY = @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
@@ -66,14 +66,14 @@ OUTPUT_LANGUAGE = English
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
-BRIEF_MEMBER_DESC = YES
+BRIEF_MEMBER_DESC = NO
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
-REPEAT_BRIEF = YES
+REPEAT_BRIEF = NO
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
@@ -462,22 +462,23 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = @abs_srcdir@/../doc/mainpage.dox \
- @abs_srcdir@/../slv2/lv2.h \
- @abs_srcdir@/../slv2/types.h \
- @abs_srcdir@/../slv2/util.h \
- @abs_srcdir@/../slv2/value.h \
- @abs_srcdir@/../slv2/values.h \
- @abs_srcdir@/../slv2/world.h \
- @abs_srcdir@/../slv2/plugin.h \
- @abs_srcdir@/../slv2/pluginclass.h \
- @abs_srcdir@/../slv2/pluginclasses.h \
- @abs_srcdir@/../slv2/plugininstance.h \
- @abs_srcdir@/../slv2/plugins.h \
- @abs_srcdir@/../slv2/port.h \
- @abs_srcdir@/../slv2/pluginui.h \
- @abs_srcdir@/../slv2/pluginuis.h \
- @abs_srcdir@/../slv2/pluginuiinstance.h
+INPUT = @SLV2_SRCDIR@/doc/mainpage.dox \
+ @SLV2_SRCDIR@/slv2/types.h \
+ @SLV2_SRCDIR@/slv2/util.h \
+ @SLV2_SRCDIR@/slv2/value.h \
+ @SLV2_SRCDIR@/slv2/values.h \
+ @SLV2_SRCDIR@/slv2/world.h \
+ @SLV2_SRCDIR@/slv2/plugin.h \
+ @SLV2_SRCDIR@/slv2/pluginclass.h \
+ @SLV2_SRCDIR@/slv2/pluginclasses.h \
+ @SLV2_SRCDIR@/slv2/plugininstance.h \
+ @SLV2_SRCDIR@/slv2/plugins.h \
+ @SLV2_SRCDIR@/slv2/port.h \
+ @SLV2_SRCDIR@/slv2/pluginui.h \
+ @SLV2_SRCDIR@/slv2/pluginuis.h \
+ @SLV2_SRCDIR@/slv2/pluginuiinstance.h
+
+ #@SLV2_SRCDIR@/slv2/lv2.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