mirror of
https://git.openafs.org/openafs.git
synced 2025-01-18 23:10:58 +00:00
1141d120a5
Add an optional make target (make dox) and doxygen configuration to generate doxygen output files. Auto-detect when the doxygen and graphviz dot tools are available. When dot is present, configure doxygen to create dependency graphs. Since the graph generation can take a very long time, a new configure option has been added to override the dot tool auto-detection. To disable the graph generation (even if dot is installed), run configure with the option: --without-dot When graph generation is desired, but graphviz dot is not present in the PATH, specify the path to dot with the configure option --with-dot=<path-to-dot>. The configure summary has been updated to show when doxygen document and graph generation is configured. Thank you Jason Edgecombe for providing the doxygen configuration for OpenAFS. Change-Id: Ie875fc2961877ee76e4c17631bbb95c29ef20b9e Reviewed-on: http://gerrit.openafs.org/10970 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: D Brashear <shadow@your-file-system.com>
61 lines
1.5 KiB
Plaintext
61 lines
1.5 KiB
Plaintext
#
|
|
# This file describes the settings to be used by the documentation system
|
|
# doxygen (www.doxygen.org) for OpenAFS.
|
|
#
|
|
|
|
PROJECT_NAME = "OpenAFS"
|
|
PROJECT_BRIEF = "OpenAFS distributed network file system"
|
|
PROJECT_LOGO = src/WINNT/afsd/OpenAFS.ico
|
|
OUTPUT_DIRECTORY = doc/doxygen/output
|
|
|
|
ABBREVIATE_BRIEF = "The $name class" "The $name widget" "The $name file" \
|
|
is provides specifies contains represents a an the
|
|
QT_AUTOBRIEF = YES
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
SYMBOL_CACHE_SIZE = 7
|
|
LOOKUP_CACHE_SIZE = 2
|
|
CASE_SENSE_NAMES = NO
|
|
HIDE_SCOPE_NAMES = YES
|
|
|
|
GENERATE_DOCSET = YES
|
|
GENERATE_TREEVIEW = YES
|
|
GENERATE_LATEX = NO
|
|
|
|
DOCSET_BUNDLE_ID = org.openafs.Project
|
|
DOCSET_PUBLISHER_ID = org.openafs.Publisher
|
|
QHP_NAMESPACE = org.openafs.Project
|
|
ECLIPSE_DOC_ID = org.openafs.Project
|
|
|
|
HAVE_DOT = @HAVE_DOT@
|
|
DOT_PATH = @DOT_PATH@
|
|
CALL_GRAPH = YES
|
|
CALLER_GRAPH = YES
|
|
|
|
EXTRACT_ALL = YES
|
|
INPUT = doc/doxygen/input src
|
|
RECURSIVE = YES
|
|
EXCLUDE = \
|
|
src/cf \
|
|
src/config \
|
|
src/dviced \
|
|
src/dvolser \
|
|
src/external \
|
|
src/finale \
|
|
src/JAVA \
|
|
src/kauth \
|
|
src/libafs \
|
|
src/mcas \
|
|
src/NTObjdir \
|
|
src/packaging \
|
|
src/shlibafsrpc \
|
|
src/tbudb \
|
|
src/tbutc \
|
|
src/tests \
|
|
src/tools \
|
|
src/tptserver \
|
|
src/tsalvaged \
|
|
src/tubik \
|
|
src/tvlserver \
|
|
src/tvolser \
|
|
|