Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
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".
  • Loading branch information
kgaillot committed Mar 31, 2015
1 parent c5c2e67 commit 1486d10
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions Doxyfile.in
Expand Up @@ -733,9 +733,8 @@ WARN_LOGFILE =
# spaces.
# Note: If this tag is empty the current directory is searched.

INPUT = include/crm \
include/crm_config.h \
include/doxygen.h
INPUT = include \
lib

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

CALL_GRAPH = YES
CALL_GRAPH = NO

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

CALLER_GRAPH = YES
CALLER_GRAPH = NO

# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
Expand Down
2 changes: 1 addition & 1 deletion GNUmakefile
Expand Up @@ -265,7 +265,7 @@ global: clean-generic
groff -mandoc `man -w ./$<` -T html > $@
rsync -azxlSD --progress $@ root@www.clusterlabs.org:/var/www/html/man/

doxygen:
doxygen: Doxyfile
doxygen Doxyfile

abi:
Expand Down

0 comments on commit 1486d10

Please sign in to comment.