summaryrefslogtreecommitdiff
path: root/doxygen
diff options
context:
space:
mode:
authorJari Vetoniemi <mailroxas@gmail.com>2014-04-10 17:26:42 +0300
committerJari Vetoniemi <mailroxas@gmail.com>2014-04-10 17:26:42 +0300
commit8631506d9d1522f1a24e528f75682201b4f3cc7b (patch)
tree637586b72f4e8608d673ab582744dc4b8c6d60a7 /doxygen
parent4a931c5ed4aaa0637bd9d41f7e45e9f22d9513ce (diff)
downloadbemenu-8631506d9d1522f1a24e528f75682201b4f3cc7b.tar.gz
bemenu-8631506d9d1522f1a24e528f75682201b4f3cc7b.tar.bz2
bemenu-8631506d9d1522f1a24e528f75682201b4f3cc7b.zip
Update documentation, include only public API in doxygen output.
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Doxyfile.in6
-rw-r--r--doxygen/Mainpage.dox2
2 files changed, 5 insertions, 3 deletions
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
index fcd3604..3b80187 100644
--- a/doxygen/Doxyfile.in
+++ b/doxygen/Doxyfile.in
@@ -90,7 +90,7 @@ OUTPUT_LANGUAGE = English
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
-BRIEF_MEMBER_DESC = NO
+BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
# description of a member or function before the detailed description
@@ -765,7 +765,7 @@ INPUT_ENCODING = UTF-8
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
# *.qsf, *.as and *.js.
-FILE_PATTERNS =
+FILE_PATTERNS = *.h *.dox
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
@@ -796,7 +796,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = internal.h
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
diff --git a/doxygen/Mainpage.dox b/doxygen/Mainpage.dox
index 8da4792..869071c 100644
--- a/doxygen/Mainpage.dox
+++ b/doxygen/Mainpage.dox
@@ -16,4 +16,6 @@ Features:
- Curses
bemenu also provides 'bemenu' executable that is compatible with dmenu interface.
+
+Get started on the <a href="modules.html">Modules</a> page.
*/