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