aboutsummaryrefslogtreecommitdiff
path: root/Doxyfile
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 13:11:54 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-26 13:11:54 +0200
commitad3e4f50ab83036ab974b4f30295c873dac3c7f0 (patch)
tree344531a2411259395762c7ac91c802cafd090b92 /Doxyfile
parentf35e4886d4036a90617305003959b8b9e6b62f43 (diff)
no more undocumented things
Diffstat (limited to 'Doxyfile')
-rw-r--r--Doxyfile12
1 files changed, 10 insertions, 2 deletions
diff --git a/Doxyfile b/Doxyfile
index 3dd7951..fccbfdf 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -4,10 +4,15 @@ PROJECT_NAME = "puzzlebox"
OUTPUT_DIRECTORY = doxygen
LAYOUT_FILE = docs/doxygen-layout.xml
+# read these files first (fixes broken links)
INPUT += readme.md
+INPUT += lib/pbdrv/pb-mod.h
+INPUT += client/cmd.h
+
+# find remaining files
+INPUT += lib/pbdrv
INPUT += lib/mpack
INPUT += lib/i2ctcp
-INPUT += lib/pbdrv
INPUT += client
INPUT += main
INPUT += puzzle
@@ -15,6 +20,7 @@ INPUT += puzzle
EXCLUDE = lib/mpack/src
EXCLUDE_PATTERNS = **/build
EXCLUDE_SYMLINKS = YES
+EXCLUDE_SYMBOLS = _*
FILE_PATTERNS = *.c *.cpp *.h *.hpp *.md *.dox
RECURSIVE = YES
@@ -24,10 +30,12 @@ GENERATE_LATEX = NO
ALIASES += I2C="I&sup2;C"
INPUT_FILTER = "sed -e 's/\<I2C\>\|\<I<sup>2<\/sup>C\>/\\I2C/g'"
-USE_MDFILE_AS_MAINPAGE = readme.md
+USE_MDFILE_AS_MAINPAGE = ./readme.md
HTML_INDEX_NUM_ENTRIES = 1 # collapse trees by default
REPEAT_BRIEF = NO
INTERNAL_DOCS = YES
EXTRACT_STATIC = YES
+QUIET = YES
+