summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGabor X Toth <*@tg-x.net>2016-01-11 21:23:13 +0000
committerGabor X Toth <*@tg-x.net>2016-01-11 21:23:13 +0000
commit1e53d26243bc986844a7b5b53bedeefb61dd7960 (patch)
tree6cc5f88c8db9ce7faf8be67a044ffa9ebf87e71a /doc
parent65c06e4a6d06d943d085bd7a0792831982cbf555 (diff)
doxygen config
Diffstat (limited to 'doc')
-rw-r--r--doc/doc.h11
-rw-r--r--doc/doxygen/gnunet.doxy13
-rw-r--r--doc/doxygen/logo.pngbin0 -> 3299 bytes
3 files changed, 19 insertions, 5 deletions
diff --git a/doc/doc.h b/doc/doc.h
new file mode 100644
index 000000000..df8fe6c0c
--- /dev/null
+++ b/doc/doc.h
@@ -0,0 +1,11 @@
+/**
+ * @mainpage GNUnet documentation
+ *
+ * @section Introduction
+ *
+ * See the [Modules](modules.html) section for documentation of the various services, APIs and libraries of GNUnet.
+ *
+ * Some additional documentation can be found under [Files](files.html), in the src/include/ directory.
+ *
+ * See also the [handbooks](https://gnunet.org/handbooks) for installation, users, and developers.
+ */
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy
index f99d139b5..6872d97a4 100644
--- a/doc/doxygen/gnunet.doxy
+++ b/doc/doxygen/gnunet.doxy
@@ -6,6 +6,7 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = GNUnet
PROJECT_NUMBER = 0.10.x
+PROJECT_LOGO = logo.png
OUTPUT_DIRECTORY = .
CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English
@@ -27,7 +28,8 @@ INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = ../..
STRIP_FROM_INC_PATH = ../../src/include \
- src/include
+ src/include \
+ include
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = NO
@@ -67,7 +69,7 @@ SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
-SORT_GROUP_NAMES = NO
+SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
@@ -92,7 +94,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = ../..
+INPUT = ../../src ../../contrib ../../doc
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
@@ -146,7 +148,7 @@ FILE_PATTERNS = *.c \
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
-EXCLUDE_PATTERNS = */test_* */.svn/* */perf_*
+EXCLUDE_PATTERNS = */test_* */.svn/* */.git/* */perf_* .*
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
@@ -287,7 +289,8 @@ CALL_GRAPH = YES
CALLER_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
-DOT_IMAGE_FORMAT = png
+DOT_IMAGE_FORMAT = svg
+INTERACTIVE_SVG = NO
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
diff --git a/doc/doxygen/logo.png b/doc/doxygen/logo.png
new file mode 100644
index 000000000..aa2443046
--- /dev/null
+++ b/doc/doxygen/logo.png
Binary files differ