Skip to content

Commit e46b9cd

Browse files
committed
Fix a number of things with the generated docs, including translating triple-backtick code blocks into a form doxygen understands.
1 parent 9a7de35 commit e46b9cd

File tree

4 files changed

+457
-441
lines changed

4 files changed

+457
-441
lines changed

doc/Doxyfile.in

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,13 @@ EXCLUDE_SYMLINKS = NO
805805
# Note that the wildcards are matched against the file with absolute path, so to
806806
# exclude all test directories for example use the pattern */test/*
807807

808-
EXCLUDE_PATTERNS =
808+
EXCLUDE_PATTERNS = \
809+
*/json_object_private.h \
810+
*/debug.h \
811+
*/*config.h \
812+
*/random_seed.h \
813+
*/strerror_*h \
814+
*/*compat.h
809815

810816
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
811817
# (namespaces, classes, functions, etc.) that should be excluded from the
@@ -816,7 +822,11 @@ EXCLUDE_PATTERNS =
816822
# Note that the wildcards are matched against the file with absolute path, so to
817823
# exclude all test directories use the pattern */test/*
818824

819-
EXCLUDE_SYMBOLS =
825+
EXCLUDE_SYMBOLS = \
826+
_json_c_* \
827+
_LH_* \
828+
_printbuf_* \
829+
__STRING
820830

821831
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
822832
# that contain example code fragments that are included (see the \include
@@ -859,7 +869,7 @@ IMAGE_PATH =
859869
# code is scanned, but not when the output code is generated. If lines are added
860870
# or removed, the anchors will not be placed correctly.
861871

862-
INPUT_FILTER =
872+
INPUT_FILTER = @CMAKE_CURRENT_SOURCE_DIR@/fixup_markdown.sh
863873

864874
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
865875
# basis. Doxygen will compare the file name with each pattern and apply the

doc/fixup_markdown.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/sh
2+
#
3+
# Doxygen markdown doesn't support triple-backticks like github does.
4+
# Convert all of those to space-prefixed blocks instead.
5+
#
6+
awk '/```/ { prefix=!prefix; print ""; next; } { if (prefix) { printf " "; } print $0; } ' "$@"

0 commit comments

Comments
 (0)