1
# Doxyfile: default configuration for `doxygen'.
3
# We used to explicitly list inputs (for faster doxygen runs), but
4
# switched to recursive scan because we have a large number of inputs
5
# and almost everybody forgot to update the list to reflect latest changes.
6
FILE_PATTERNS = *.cpp *.h
8
EXCLUDE_PATTERNS = sp-skeleton.*
9
# Input used to be generated with the command
10
# find -name '*.cpp' -o -name '*.h'|xargs grep -l '\\file'|sort|sed 's,^./, ,;s,$, \\,'
11
# (and remove the non source files sp-skeleton.*).
13
# application/application.cpp \
14
# (file listing was here...)
17
# Uncomment this to treat undocumented things as if they had an empty
18
# documentation string; comment it out to suppress all undocumented things from
20
# Leaving it uncommented allows using doxygen output as the primary information
21
# source about a class (without needing to look at the source code to look for
22
# undocumented things).
23
# OTOH, you may find it annoying to have reems of relatively unhelpful
24
# information: commenting it out gives more compact display of the helpful
26
# I'm commenting it out for now to facilitate checking existing doc comments
27
# for doxygen correctness.
30
# I'll disable this for the moment, to reduce the number of files in the output.
33
# Keep the output out of the src directory so that it doesn't get in the way of
35
OUTPUT_DIRECTORY = ../doxygen
37
# In absence of explicit `\brief', treat the first "sentence" as the brief part
38
# and the rest as detail. (With explicit `\brief', the first _paragraph_ is
39
# considered the brief part.)
41
# It's unclear whether programmers should deliberately use this facility.
42
# Advantage: Less clutter.
43
# Disadvantage: Absence of `\brief' may indicate that the comment was written
44
# by someone unfamiliar with doxygen and not giving thought to what the brief
45
# description should be. Using explicit `\brief' may facilitate checking
46
# non-\briefed comments for doxygen correctness.
47
# OTOH, using `\brief' may be parrot-like: it doesn't necessarily indicate
48
# doxygen familiarity.
49
JAVADOC_AUTOBRIEF = yes
51
WARN_IF_UNDOCUMENTED = yes
53
GENERATE_TODOLIST = yes
55
GENERATE_BUGLIST = yes
57
REFERENCED_BY_RELATION = yes
61
WARN_LOGFILE = doxygen-log