Skip to content

Commit 1486d10

Browse files
committed
Fix: doc: enable doxygen comment blocks in source under lib
Previously doxygen public API documentation would be produced only if the comment blocks were in the header files. Now it will use comment blocks in source files as well. This also enables viewing indexed source code within the doxygen documentation and showing more include graphs. Non-public APIs are unaffected because INPUT only controls what is processed, not what is documented. However, both public and private source files and headers under the include and lib directories are now viewable in the indexed source code, and private data structures do show up under "Data Structures".
1 parent c5c2e67 commit 1486d10

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

Doxyfile.in

+4-5
Original file line numberDiff line numberDiff line change
@@ -733,9 +733,8 @@ WARN_LOGFILE =
733733
# spaces.
734734
# Note: If this tag is empty the current directory is searched.
735735

736-
INPUT = include/crm \
737-
include/crm_config.h \
738-
include/doxygen.h
736+
INPUT = include \
737+
lib
739738

740739
# This tag can be used to specify the character encoding of the source files
741740
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2150,7 +2149,7 @@ INCLUDED_BY_GRAPH = YES
21502149
# The default value is: NO.
21512150
# This tag requires that the tag HAVE_DOT is set to YES.
21522151

2153-
CALL_GRAPH = YES
2152+
CALL_GRAPH = NO
21542153

21552154
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
21562155
# dependency graph for every global function or class method.
@@ -2161,7 +2160,7 @@ CALL_GRAPH = YES
21612160
# The default value is: NO.
21622161
# This tag requires that the tag HAVE_DOT is set to YES.
21632162

2164-
CALLER_GRAPH = YES
2163+
CALLER_GRAPH = NO
21652164

21662165
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
21672166
# hierarchy of all classes instead of a textual one.

GNUmakefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ global: clean-generic
265265
groff -mandoc `man -w ./$<` -T html > $@
266266
rsync -azxlSD --progress $@ [email protected]:/var/www/html/man/
267267

268-
doxygen:
268+
doxygen: Doxyfile
269269
doxygen Doxyfile
270270

271271
abi:

0 commit comments

Comments
 (0)