Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pymilter
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
misc
pymilter
Commits
73e1f469
Commit
73e1f469
authored
16 years ago
by
Stuart Gathman
Browse files
Options
Downloads
Patches
Plain Diff
Upgrade to doxygen-1.5.7
parent
2e45d6e1
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
Doxyfile
+292
-71
292 additions, 71 deletions
Doxyfile
with
292 additions
and
71 deletions
Doxyfile
+
292
−
71
View file @
73e1f469
# Doxyfile 1.
4
.7
# Doxyfile 1.
5
.7
.1
# This file describes the settings to be used by the documentation system
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
# doxygen (www.doxygen.org) for a project
...
@@ -14,6 +14,14 @@
...
@@ -14,6 +14,14 @@
# Project related configuration options
# Project related configuration options
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
# by quotes) that should identify the project.
...
@@ -45,24 +53,15 @@ CREATE_SUBDIRS = NO
...
@@ -45,24 +53,15 @@ CREATE_SUBDIRS = NO
# documentation generated by doxygen is written. Doxygen will use this
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# The default language is English, other supported languages are:
# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
# Swedish, and Ukrainian.
# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
# Spanish, Swedish, and Ukrainian.
OUTPUT_LANGUAGE = English
OUTPUT_LANGUAGE = English
# This tag can be used to specify the encoding used in the generated output.
# The encoding is not always determined by the language that is chosen,
# but also whether or not the output is meant for Windows or non-Windows users.
# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
# forces the Windows encoding (this is the default for the Windows binary),
# whereas setting the tag to NO uses a Unix-style encoding (the default for
# all platforms other than Windows).
USE_WINDOWS_ENCODING = NO
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# the file and class documentation (similar to JavaDoc).
...
@@ -135,11 +134,19 @@ SHORT_NAMES = NO
...
@@ -135,11 +134,19 @@ SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like
the
Qt-style comments
(thus requiring an
# comments will behave just like
regular
Qt-style comments
# explicit @brief command for a brief description.
#
(thus requiring an
explicit @brief command for a brief description.
)
JAVADOC_AUTOBRIEF = YES
JAVADOC_AUTOBRIEF = YES
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
# an explicit \brief command for a brief description.)
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# comments) as a brief description. This used to be the default behaviour.
...
@@ -148,13 +155,6 @@ JAVADOC_AUTOBRIEF = YES
...
@@ -148,13 +155,6 @@ JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.
DETAILS_AT_TOP = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# member inherits the documentation from any documented member that it
# re-implements.
# re-implements.
...
@@ -189,14 +189,26 @@ ALIASES =
...
@@ -189,14 +189,26 @@ ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
Java.
# sources only. Doxygen will then generate output that is more tailored for
# For instance, namespaces will be presented as packages, qualified
scopes
#
Java.
For instance, namespaces will be presented as packages, qualified
# will look different, etc.
#
scopes
will look different, etc.
OPTIMIZE_OUTPUT_JAVA = YES
OPTIMIZE_OUTPUT_JAVA = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# include (a tag file for) the STL sources as input, then you should
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.
OPTIMIZE_OUTPUT_VHDL = NO
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
# func(std::string) {}). This also make the inheritance and collaboration
...
@@ -204,6 +216,26 @@ OPTIMIZE_OUTPUT_JAVA = YES
...
@@ -204,6 +216,26 @@ OPTIMIZE_OUTPUT_JAVA = YES
BUILTIN_STL_SUPPORT = NO
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
# instead of private inheritance when no explicit protection keyword is present.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# member in the group (if any) for the other members of the group. By default
...
@@ -219,6 +251,32 @@ DISTRIBUTE_GROUP_DOC = NO
...
@@ -219,6 +251,32 @@ DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
SUBGROUPING = YES
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols
SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# Build related configuration options
# Build related configuration options
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
...
@@ -253,6 +311,14 @@ EXTRACT_LOCAL_CLASSES = YES
...
@@ -253,6 +311,14 @@ EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
EXTRACT_ANON_NSPACES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# If set to NO (the default) these members will be included in the
...
@@ -328,6 +394,12 @@ SORT_MEMBER_DOCS = YES
...
@@ -328,6 +394,12 @@ SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BRIEF_DOCS = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# NO (the default), the class list will be sorted only by class name,
...
@@ -389,9 +461,21 @@ SHOW_USED_FILES = YES
...
@@ -389,9 +461,21 @@ SHOW_USED_FILES = YES
SHOW_DIRECTORIES = YES
SHOW_DIRECTORIES = YES
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.
SHOW_FILES = YES
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page. This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.
SHOW_NAMESPACES = YES
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
the
# doxygen should invoke to get the current version for each file (typically from
# version control system). Doxygen will invoke the program by executing (via
#
the
version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
# provided by doxygen. Whatever the program writes to standard output
...
@@ -399,6 +483,15 @@ SHOW_DIRECTORIES = YES
...
@@ -399,6 +483,15 @@ SHOW_DIRECTORIES = YES
FILE_VERSION_FILTER =
FILE_VERSION_FILTER =
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
# doxygen. The layout file controls the global structure of the generated output files
# in an output format independent way. The create the layout file that represents
# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
# file name after the option, if omitted DoxygenLayout.xml will be used as the name
# of the layout file.
LAYOUT_FILE =
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
...
@@ -462,12 +555,20 @@ WARN_LOGFILE =
...
@@ -462,12 +555,20 @@ WARN_LOGFILE =
INPUT = mime.py \
INPUT = mime.py \
Milter
Milter
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
INPUT_ENCODING = UTF-8
# If the value of the INPUT tag contains directories, you can use the
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
*.f90
FILE_PATTERNS = *.py
FILE_PATTERNS = *.py
...
@@ -497,6 +598,14 @@ EXCLUDE_SYMLINKS = NO
...
@@ -497,6 +598,14 @@ EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# directories that contain example code fragments that are included (see
# the \include command).
# the \include command).
...
@@ -570,13 +679,13 @@ INLINE_SOURCES = NO
...
@@ -570,13 +679,13 @@ INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
STRIP_CODE_COMMENTS = YES
# If the REFERENCED_BY_RELATION tag is set to YES
(the default)
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# then for each documented function all documented
# functions referencing it will be listed.
# functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES
(the default)
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# then for each documented function all documented entities
# called/used by that function will be listed.
# called/used by that function will be listed.
...
@@ -674,9 +783,43 @@ HTML_STYLESHEET =
...
@@ -674,9 +783,43 @@ HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
HTML_ALIGN_MEMBERS = YES
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
HTML_DYNAMIC_SECTIONS = NO
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
GENERATE_DOCSET = NO
# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.
DOCSET_FEEDNAME = "Doxygen generated docs"
# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.
DOCSET_BUNDLE_ID = org.doxygen.Project
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a comp
ress
ed HTML help file (.chm)
# Microsoft HTML help workshop to generate a comp
il
ed HTML help file (.chm)
# of the generated HTML documentation.
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
GENERATE_HTMLHELP = NO
...
@@ -701,6 +844,12 @@ HHC_LOCATION =
...
@@ -701,6 +844,12 @@ HHC_LOCATION =
GENERATE_CHI = NO
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.
CHM_INDEX_ENCODING =
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
# normal table of contents (NO) in the .chm file.
...
@@ -712,6 +861,38 @@ BINARY_TOC = NO
...
@@ -712,6 +861,38 @@ BINARY_TOC = NO
TOC_EXPAND = NO
TOC_EXPAND = NO
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
# HTML documentation.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
QHP_VIRTUAL_FOLDER = doc
# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file .
QHG_LOCATION =
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
# the value YES disables it.
...
@@ -723,12 +904,20 @@ DISABLE_INDEX = NO
...
@@ -723,12 +904,20 @@ DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
ENUM_VALUES_PER_LINE = 4
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# generated containing a tree-like index structure (just like the one that
# structure should be generated to display hierarchical information.
# If the tag value is set to FRAME, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature.
# probably better off using the HTML help feature. Other possible values
# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list;
# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
# disables this behavior completely. For backwards compatibility with previous
# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
# respectively.
GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = NO
...
@@ -738,6 +927,14 @@ GENERATE_TREEVIEW = NO
...
@@ -738,6 +927,14 @@ GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 250
# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.
FORMULA_FONTSIZE = 10
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
...
@@ -1086,6 +1283,15 @@ PERL_PATH = /usr/bin/perl
...
@@ -1086,6 +1283,15 @@ PERL_PATH = /usr/bin/perl
CLASS_DIAGRAMS = YES
CLASS_DIAGRAMS = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.
MSCGEN_PATH =
# If set to YES, the inheritance and collaboration graphs will hide
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# inheritance and usage relations if the target is undocumented
# or is not a class.
# or is not a class.
...
@@ -1099,6 +1305,29 @@ HIDE_UNDOC_RELATIONS = YES
...
@@ -1099,6 +1305,29 @@ HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
HAVE_DOT = NO
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
# font does not include all possible unicode characters however, so when you need
# these (or just want a differently looking font) you can specify the font name
# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
# which can be done by putting it in a standard location or by setting the
# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
# containing the font.
DOT_FONTNAME = FreeSans
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
# The default size is 10pt.
DOT_FONTSIZE = 10
# By default doxygen will tell dot to use the output directory to look for the
# FreeSans.ttf font (which doxygen will put there itself). If you specify a
# different font using DOT_FONTNAME you can set the path where dot
# can find it using this tag.
DOT_FONTPATH =
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# indirect inheritance relations. Setting this tag to YES will force the
...
@@ -1143,19 +1372,19 @@ INCLUDE_GRAPH = YES
...
@@ -1143,19 +1372,19 @@ INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH and HAVE_DOT
tag
s are set to YES then
doxygen will
# If the CALL_GRAPH and HAVE_DOT
option
s are set to YES then
# generate a call dependency graph for every global function
or class method.
#
doxygen will
generate a call dependency graph for every global function
# Note that enabling this option will significantly increase
the time of a run.
#
or class method.
Note that enabling this option will significantly increase
# So in most cases it will be better to enable call graphs
for selected
#
the time of a run.
So in most cases it will be better to enable call graphs
# functions only using the \callgraph command.
#
for selected
functions only using the \callgraph command.
CALL_GRAPH = NO
CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
doxygen will
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# generate a caller dependency graph for every global function
or class method.
#
doxygen will
generate a caller dependency graph for every global function
# Note that enabling this option will significantly increase
the time of a run.
#
or class method.
Note that enabling this option will significantly increase
# So in most cases it will be better to enable caller
graphs for selected
#
the time of a run.
So in most cases it will be better to enable caller
# functions only using the \callergraph command.
#
graphs for selected
functions only using the \callergraph command.
CALLER_GRAPH = NO
CALLER_GRAPH = NO
...
@@ -1188,39 +1417,31 @@ DOT_PATH =
...
@@ -1188,39 +1417,31 @@ DOT_PATH =
DOTFILE_DIRS =
DOTFILE_DIRS =
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# nodes that will be shown in the graph. If the number of nodes in a graph
# this value, doxygen will try to truncate the graph, so that it fits within
# becomes larger than this value, doxygen will truncate the graph, which is
# the specified constraint. Beware that most browsers cannot cope with very
# visualized by representing a node as a red box. Note that doxygen if the
# large images.
# number of direct children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
MAX_DOT_GRAPH_WIDTH = 1024
# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
MAX_
DOT_GRAPH_
HEIGHT
=
1024
DOT_GRAPH_
MAX_NODES
=
50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# graphs generated by dot. A depth value of 3 means that only nodes reachable
# from the root by following a path via at most 3 edges will be shown. Nodes
# from the root by following a path via at most 3 edges will be shown. Nodes
# that lay further from the root node will be omitted. Note that setting this
# that lay further from the root node will be omitted. Note that setting this
# option to 1 or 2 may greatly reduce the computation time needed for large
# option to 1 or 2 may greatly reduce the computation time needed for large
# code bases. Also note that a graph may be further truncated if the graph's
# code bases. Also note that the size of a graph can be further restricted by
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
# the graph is not depth-constrained.
MAX_DOT_GRAPH_DEPTH = 0
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default,
which results in a white background.
# background. This is disabled by default,
because dot on Windows does not
# Warning: Depending on the platform used,
enabling this option may lead to
#
seem to support this out of the box.
Warning: Depending on the platform used,
# badly anti-aliased labels on the edges of
a graph (i.e. they become hard to
#
enabling this option may lead to
badly anti-aliased labels on the edges of
# read).
#
a graph (i.e. they become hard to
read).
DOT_TRANSPARENT = NO
DOT_TRANSPARENT = NO
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment