aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference.doxygen.in
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2019-03-30 12:37:04 +0100
committerDavid Robillard <d@drobilla.net>2019-03-30 12:37:04 +0100
commit5ecd64db399392493cf4f2a5154d1deb3b498c88 (patch)
treedd5c42199fa6e0ce2a1239c4a0821ffa00553d1a /doc/reference.doxygen.in
parentcd9af80d241c4f0b29c8dba916c03d12384753a5 (diff)
downloadserd-5ecd64db399392493cf4f2a5154d1deb3b498c88.tar.gz
serd-5ecd64db399392493cf4f2a5154d1deb3b498c88.tar.bz2
serd-5ecd64db399392493cf4f2a5154d1deb3b498c88.zip
Improve documentation
Diffstat (limited to 'doc/reference.doxygen.in')
-rw-r--r--doc/reference.doxygen.in15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index e82b1208..8e11f865 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -44,7 +44,7 @@ PROJECT_NUMBER = @SERD_VERSION@
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
-PROJECT_BRIEF =
+PROJECT_BRIEF = "A lightweight library for RDF storage and serialisation"
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
@@ -803,7 +803,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = @SERD_SRCDIR@/serd/serd.h
+INPUT = @SERD_SRCDIR@/serd/serd.h \
+ @SERD_SRCDIR@/doc/mainpage.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -952,7 +953,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 = @SERD_SRCDIR@/doc/mainpage.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
@@ -984,7 +985,7 @@ STRIP_CODE_COMMENTS = YES
# entity all documented functions referencing it will be listed.
# The default value is: NO.
-REFERENCED_BY_RELATION = YES
+REFERENCED_BY_RELATION = NO
# If the REFERENCES_RELATION tag is set to YES then for each documented function
# all documented entities called/used by that function will be listed.
@@ -1008,7 +1009,7 @@ REFERENCES_LINK_SOURCE = YES
# The default value is: YES.
# This tag requires that the tag SOURCE_BROWSER is set to YES.
-SOURCE_TOOLTIPS = YES
+SOURCE_TOOLTIPS = NO
# If the USE_HTAGS tag is set to YES then the references to source code will
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
@@ -1203,7 +1204,7 @@ HTML_TIMESTAMP = NO
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
-HTML_DYNAMIC_MENUS = YES
+HTML_DYNAMIC_MENUS = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
@@ -1423,7 +1424,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-DISABLE_INDEX = YES
+DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag