Index: crashpad.doxy |
diff --git a/crashpad.doxy b/crashpad.doxy |
index 2b028e0ab1adb85ab72b1db2002b6e8fab0f5918..d02ad2117699f3e30284b85e6667069905c56533 100644 |
--- a/crashpad.doxy |
+++ b/crashpad.doxy |
@@ -1,4 +1,4 @@ |
-# Doxyfile 1.8.7 |
+# Doxyfile 1.8.9.1 |
# This file describes the settings to be used by the documentation system |
# doxygen (www.doxygen.org) for a project. |
@@ -44,12 +44,12 @@ PROJECT_NUMBER = |
# for a project that appears at the top of each page and should give viewer a |
# quick idea about the purpose of the project. Keep the description short. |
-# PROJECT_BRIEF = "Crashpad" |
+PROJECT_BRIEF = |
-# With the PROJECT_LOGO tag one can specify an logo or icon that is included in |
-# the documentation. The maximum height of the logo should not exceed 55 pixels |
-# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo |
-# to the output directory. |
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
+# in the documentation. The maximum height of the logo should not exceed 55 |
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
+# the logo to the output directory. |
PROJECT_LOGO = |
@@ -60,7 +60,7 @@ PROJECT_LOGO = |
OUTPUT_DIRECTORY = out |
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- |
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- |
# directories (in 2 levels) under the output directory of each output format and |
# will distribute the generated files over these directories. Enabling this |
# option can be useful when feeding doxygen a huge amount of source files, where |
@@ -93,14 +93,14 @@ ALLOW_UNICODE_NAMES = NO |
OUTPUT_LANGUAGE = English |
-# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member |
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
# descriptions after the members that are listed in the file and class |
# documentation (similar to Javadoc). Set to NO to disable this. |
# The default value is: YES. |
BRIEF_MEMBER_DESC = YES |
-# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief |
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief |
# description of a member or function before the detailed description |
# |
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
@@ -135,7 +135,7 @@ ALWAYS_DETAILED_SEC = NO |
INLINE_INHERITED_MEMB = NO |
-# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path |
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path |
# before files name in the file list and in the header files. If set to NO the |
# shortest path that makes the file name unique will be used |
# The default value is: YES. |
@@ -161,7 +161,9 @@ STRIP_FROM_PATH = |
# specify the list of include paths that are normally passed to the compiler |
# using the -I flag. |
-STRIP_FROM_INC_PATH = . compat/mac compat/non_win |
+STRIP_FROM_INC_PATH = . \ |
+ compat/mac \ |
+ compat/non_win |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
# less readable) file names. This can be useful is your file systems doesn't |
@@ -205,9 +207,9 @@ MULTILINE_CPP_IS_BRIEF = NO |
INHERIT_DOCS = YES |
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a |
-# new page for each member. If set to NO, the documentation of a member will be |
-# part of the file/class/namespace that contains it. |
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new |
+# page for each member. If set to NO, the documentation of a member will be part |
+# of the file/class/namespace that contains it. |
# The default value is: NO. |
SEPARATE_MEMBER_PAGES = NO |
@@ -276,7 +278,7 @@ OPTIMIZE_OUTPUT_VHDL = NO |
# instance to make doxygen treat .inc files as Fortran files (default is PHP), |
# and .f files as C (default is Fortran), use: inc=Fortran f=C. |
# |
-# Note For files without extension you can use no_extension as a placeholder. |
+# Note: For files without extension you can use no_extension as a placeholder. |
# |
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
# the files are not read by doxygen. |
@@ -295,8 +297,8 @@ MARKDOWN_SUPPORT = YES |
# When enabled doxygen tries to link words that correspond to documented |
# classes, or namespaces to their corresponding documentation. Such a link can |
-# be prevented in individual cases by by putting a % sign in front of the word |
-# or globally by setting AUTOLINK_SUPPORT to NO. |
+# be prevented in individual cases by putting a % sign in front of the word or |
+# globally by setting AUTOLINK_SUPPORT to NO. |
# The default value is: YES. |
AUTOLINK_SUPPORT = YES |
@@ -336,7 +338,7 @@ SIP_SUPPORT = NO |
IDL_PROPERTY_SUPPORT = YES |
# 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 |
# all members of a group must be documented explicitly. |
# The default value is: NO. |
@@ -401,7 +403,7 @@ LOOKUP_CACHE_SIZE = 0 |
# Build related configuration options |
#--------------------------------------------------------------------------- |
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in |
# documentation are documented, even if no documentation was available. Private |
# class members and static file members will be hidden unless the |
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. |
@@ -411,35 +413,35 @@ LOOKUP_CACHE_SIZE = 0 |
EXTRACT_ALL = NO |
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will |
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will |
# be included in the documentation. |
# The default value is: NO. |
EXTRACT_PRIVATE = NO |
-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
# scope will be included in the documentation. |
# The default value is: NO. |
EXTRACT_PACKAGE = NO |
-# If the EXTRACT_STATIC tag is set to YES all static members of a file will be |
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be |
# included in the documentation. |
# The default value is: NO. |
EXTRACT_STATIC = NO |
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined |
-# locally in source files will be included in the documentation. If set to NO |
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined |
+# locally in source files will be included in the documentation. If set to NO, |
# only classes defined in header files are included. Does not have any effect |
# for Java sources. |
# The default value is: YES. |
EXTRACT_LOCAL_CLASSES = YES |
-# This flag is only useful for Objective-C code. When set to YES local methods, |
+# This flag is only useful for Objective-C code. If set to YES, local methods, |
# which are defined in the implementation section but not in the interface are |
-# included in the documentation. If set to NO only methods in the interface are |
+# included in the documentation. If set to NO, only methods in the interface are |
# included. |
# The default value is: NO. |
@@ -464,21 +466,21 @@ HIDE_UNDOC_MEMBERS = NO |
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all |
# undocumented classes that are normally visible in the class hierarchy. If set |
-# to NO these classes will be included in the various overviews. This option has |
-# no effect if EXTRACT_ALL is enabled. |
+# to NO, these classes will be included in the various overviews. This option |
+# has no effect if EXTRACT_ALL is enabled. |
# The default value is: NO. |
HIDE_UNDOC_CLASSES = NO |
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
-# (class|struct|union) declarations. If set to NO these declarations will be |
+# (class|struct|union) declarations. If set to NO, these declarations will be |
# included in the documentation. |
# The default value is: NO. |
HIDE_FRIEND_COMPOUNDS = NO |
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any |
-# documentation blocks found inside the body of a function. If set to NO these |
+# documentation blocks found inside the body of a function. If set to NO, these |
# blocks will be appended to the function's detailed documentation block. |
# The default value is: NO. |
@@ -492,7 +494,7 @@ HIDE_IN_BODY_DOCS = NO |
INTERNAL_DOCS = NO |
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file |
-# names in lower-case letters. If set to YES upper-case letters are also |
+# names in lower-case letters. If set to YES, upper-case letters are also |
# allowed. This is useful if you have classes or files whose names only differ |
# in case and if your file system supports case sensitive file names. Windows |
# and Mac users are advised to set this option to NO. |
@@ -501,12 +503,19 @@ INTERNAL_DOCS = NO |
CASE_SENSE_NAMES = YES |
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with |
-# their full class and namespace scopes in the documentation. If set to YES the |
+# their full class and namespace scopes in the documentation. If set to YES, the |
# scope will be hidden. |
# The default value is: NO. |
HIDE_SCOPE_NAMES = NO |
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will |
+# append additional text to a page's title, such as Class Reference. If set to |
+# YES the compound reference will be hidden. |
+# The default value is: NO. |
+ |
+HIDE_COMPOUND_REFERENCE= NO |
+ |
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
# the files that are included by a file in the documentation of that file. |
# The default value is: YES. |
@@ -534,14 +543,14 @@ INLINE_INFO = YES |
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the |
# (detailed) documentation of file and class members alphabetically by member |
-# name. If set to NO the members will appear in declaration order. |
+# name. If set to NO, the members will appear in declaration order. |
# The default value is: YES. |
SORT_MEMBER_DOCS = YES |
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief |
# descriptions of file, namespace and class members alphabetically by member |
-# name. If set to NO the members will appear in declaration order. Note that |
+# name. If set to NO, the members will appear in declaration order. Note that |
# this will also influence the order of the classes in the class list. |
# The default value is: NO. |
@@ -586,27 +595,25 @@ SORT_BY_SCOPE_NAME = NO |
STRICT_PROTO_MATCHING = NO |
-# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the |
-# todo list. This list is created by putting \todo commands in the |
-# documentation. |
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo |
+# list. This list is created by putting \todo commands in the documentation. |
# The default value is: YES. |
GENERATE_TODOLIST = YES |
-# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the |
-# test list. This list is created by putting \test commands in the |
-# documentation. |
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test |
+# list. This list is created by putting \test commands in the documentation. |
# The default value is: YES. |
GENERATE_TESTLIST = YES |
-# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug |
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug |
# list. This list is created by putting \bug commands in the documentation. |
# The default value is: YES. |
GENERATE_BUGLIST = YES |
-# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) |
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) |
# the deprecated list. This list is created by putting \deprecated commands in |
# the documentation. |
# The default value is: YES. |
@@ -631,8 +638,8 @@ ENABLED_SECTIONS = |
MAX_INITIALIZER_LINES = 30 |
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at |
-# the bottom of the documentation of classes and structs. If set to YES the list |
-# will mention the files that were used to generate the documentation. |
+# the bottom of the documentation of classes and structs. If set to YES, the |
+# list will mention the files that were used to generate the documentation. |
# The default value is: YES. |
SHOW_USED_FILES = YES |
@@ -680,8 +687,7 @@ LAYOUT_FILE = |
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
# For LaTeX the style of the bibliography can be controlled using |
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
-# search path. Do not use file names with spaces, bibtex cannot handle them. See |
-# also \cite for info how to create references. |
+# search path. See also \cite for info how to create references. |
CITE_BIB_FILES = |
@@ -697,7 +703,7 @@ CITE_BIB_FILES = |
QUIET = NO |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
-# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES |
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES |
# this implies that the warnings are on. |
# |
# Tip: Turn warnings on while writing the documentation. |
@@ -705,7 +711,7 @@ QUIET = NO |
WARNINGS = YES |
-# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate |
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate |
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag |
# will automatically be disabled. |
# The default value is: YES. |
@@ -722,8 +728,8 @@ WARN_IF_DOC_ERROR = YES |
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
# are documented, but have no documentation for their parameters or return |
-# value. If set to NO doxygen will only warn about wrong or incomplete parameter |
-# documentation, but not about the absence of documentation. |
+# value. If set to NO, doxygen will only warn about wrong or incomplete |
+# parameter documentation, but not about the absence of documentation. |
# The default value is: NO. |
WARN_NO_PARAMDOC = NO |
@@ -774,7 +780,11 @@ INPUT_ENCODING = UTF-8 |
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, |
# *.qsf, *.as and *.js. |
-FILE_PATTERNS = *.c *.cc *.h *.m *.mm |
+FILE_PATTERNS = *.c \ |
+ *.cc \ |
+ *.h \ |
+ *.m \ |
+ *.mm |
# The RECURSIVE tag can be used to specify whether or not subdirectories should |
# be searched for input files as well. |
@@ -872,7 +882,7 @@ INPUT_FILTER = |
FILTER_PATTERNS = |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
-# INPUT_FILTER ) will also be used to filter the input files that are used for |
+# INPUT_FILTER) will also be used to filter the input files that are used for |
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). |
# The default value is: NO. |
@@ -932,7 +942,7 @@ REFERENCED_BY_RELATION = NO |
REFERENCES_RELATION = NO |
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set |
-# to YES, then the hyperlinks from functions in REFERENCES_RELATION and |
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and |
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will |
# link to the documentation. |
# The default value is: YES. |
@@ -1009,7 +1019,7 @@ IGNORE_PREFIX = |
# Configuration options related to the HTML output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output |
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output |
# The default value is: YES. |
GENERATE_HTML = YES |
@@ -1071,13 +1081,15 @@ HTML_FOOTER = |
HTML_STYLESHEET = |
-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- |
-# defined cascading style sheet that is included after the standard style sheets |
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
+# cascading style sheets that are included after the standard style sheets |
# created by doxygen. Using this option one can overrule certain style aspects. |
# This is preferred over using HTML_STYLESHEET since it does not replace the |
-# standard style sheet and is therefor more robust against future updates. |
-# Doxygen will copy the style sheet file to the output directory. For an example |
-# see the documentation. |
+# standard style sheet and is therefore more robust against future updates. |
+# Doxygen will copy the style sheet files to the output directory. |
+# Note: The order of the extra style sheet files is of importance (e.g. the last |
+# style sheet in the list overrules the setting of the previous ones in the |
+# list). For an example see the documentation. |
# This tag requires that the tag GENERATE_HTML is set to YES. |
HTML_EXTRA_STYLESHEET = |
@@ -1093,7 +1105,7 @@ HTML_EXTRA_STYLESHEET = |
HTML_EXTRA_FILES = |
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
-# will adjust the colors in the stylesheet and background images according to |
+# will adjust the colors in the style sheet and background images according to |
# this color. Hue is specified as an angle on a colorwheel, see |
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
@@ -1221,28 +1233,28 @@ GENERATE_HTMLHELP = NO |
CHM_FILE = |
# The HHC_LOCATION tag can be used to specify the location (absolute path |
-# including file name) of the HTML help compiler ( hhc.exe). If non-empty |
+# including file name) of the HTML help compiler (hhc.exe). If non-empty, |
# doxygen will try to run the HTML help compiler on the generated index.hhp. |
# The file has to be specified with full path. |
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
HHC_LOCATION = |
-# The GENERATE_CHI flag controls if a separate .chi index file is generated ( |
-# YES) or that it should be included in the master .chm file ( NO). |
+# The GENERATE_CHI flag controls if a separate .chi index file is generated |
+# (YES) or that it should be included in the master .chm file (NO). |
# The default value is: NO. |
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
GENERATE_CHI = NO |
-# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) |
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) |
# and project file content. |
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
CHM_INDEX_ENCODING = |
-# The BINARY_TOC flag controls whether a binary table of contents is generated ( |
-# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it |
+# The BINARY_TOC flag controls whether a binary table of contents is generated |
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
# enables the Previous and Next buttons. |
# The default value is: NO. |
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
@@ -1356,7 +1368,7 @@ DISABLE_INDEX = NO |
# index structure (just like the one that is generated for HTML Help). For this |
# to work a browser that supports JavaScript, DHTML, CSS and frames is required |
# (i.e. any modern browser). Windows users are probably better off using the |
-# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can |
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
# further fine-tune the look of the index. As an example, the default style |
# sheet generated by doxygen has an example that shows how to put an image at |
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has |
@@ -1384,7 +1396,7 @@ ENUM_VALUES_PER_LINE = 0 |
TREEVIEW_WIDTH = 250 |
-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to |
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to |
# external symbols imported via tag files in a separate window. |
# The default value is: NO. |
# This tag requires that the tag GENERATE_HTML is set to YES. |
@@ -1413,7 +1425,7 @@ FORMULA_TRANSPARENT = YES |
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
# http://www.mathjax.org) which uses client side Javascript for the rendering |
-# instead of using prerendered bitmaps. Use this if you do not have LaTeX |
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
# installed or if you want to formulas look prettier in the HTML output. When |
# enabled you may also need to install MathJax separately and configure the path |
# to it using the MATHJAX_RELPATH option. |
@@ -1499,7 +1511,7 @@ SERVER_BASED_SEARCH = NO |
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the |
# search results. |
# |
-# Doxygen ships with an example indexer ( doxyindexer) and search engine |
+# Doxygen ships with an example indexer (doxyindexer) and search engine |
# (doxysearch.cgi) which are based on the open source search engine library |
# Xapian (see: http://xapian.org/). |
# |
@@ -1512,7 +1524,7 @@ EXTERNAL_SEARCH = NO |
# The SEARCHENGINE_URL should point to a search engine hosted by a web server |
# which will return the search results when EXTERNAL_SEARCH is enabled. |
# |
-# Doxygen ships with an example indexer ( doxyindexer) and search engine |
+# Doxygen ships with an example indexer (doxyindexer) and search engine |
# (doxysearch.cgi) which are based on the open source search engine library |
# Xapian (see: http://xapian.org/). See the section "External Indexing and |
# Searching" for details. |
@@ -1550,7 +1562,7 @@ EXTRA_SEARCH_MAPPINGS = |
# Configuration options related to the LaTeX output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. |
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. |
# The default value is: YES. |
GENERATE_LATEX = NO |
@@ -1581,7 +1593,7 @@ LATEX_CMD_NAME = latex |
MAKEINDEX_CMD_NAME = makeindex |
-# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX |
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
# documents. This may be useful for small projects and may help to save some |
# trees in general. |
# The default value is: NO. |
@@ -1615,23 +1627,36 @@ EXTRA_PACKAGES = |
# |
# Note: Only use a user-defined header if you know what you are doing! The |
# following commands have a special meaning inside the header: $title, |
-# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will |
-# replace them by respectively the title of the page, the current date and time, |
-# only the current date, the version number of doxygen, the project name (see |
-# PROJECT_NAME), or the project number (see PROJECT_NUMBER). |
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber, |
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty |
+# string, for the replacement values of the other commands the user is referred |
+# to HTML_HEADER. |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
LATEX_HEADER = |
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
# generated LaTeX document. The footer should contain everything after the last |
-# chapter. If it is left blank doxygen will generate a standard footer. |
+# chapter. If it is left blank doxygen will generate a standard footer. See |
+# LATEX_HEADER for more information on how to generate a default footer and what |
+# special commands can be used inside the footer. |
# |
# Note: Only use a user-defined footer if you know what you are doing! |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
LATEX_FOOTER = |
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
+# LaTeX style sheets that are included after the standard style sheets created |
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen |
+# will copy the style sheet files to the output directory. |
+# Note: The order of the extra style sheet files is of importance (e.g. the last |
+# style sheet in the list overrules the setting of the previous ones in the |
+# list). |
+# This tag requires that the tag GENERATE_LATEX is set to YES. |
+ |
+LATEX_EXTRA_STYLESHEET = |
+ |
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
# other source files which should be copied to the LATEX_OUTPUT output |
# directory. Note that the files will be copied as-is; there are no commands or |
@@ -1649,8 +1674,8 @@ LATEX_EXTRA_FILES = |
PDF_HYPERLINKS = YES |
-# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
-# the PDF file directly from the LaTeX files. Set this option to YES to get a |
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a |
# higher quality PDF documentation. |
# The default value is: YES. |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
@@ -1695,7 +1720,7 @@ LATEX_BIB_STYLE = plain |
# Configuration options related to the RTF output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The |
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The |
# RTF output is optimized for Word 97 and may not look too pretty with other RTF |
# readers/editors. |
# The default value is: NO. |
@@ -1710,7 +1735,7 @@ GENERATE_RTF = NO |
RTF_OUTPUT = rtf |
-# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF |
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF |
# documents. This may be useful for small projects and may help to save some |
# trees in general. |
# The default value is: NO. |
@@ -1747,11 +1772,21 @@ RTF_STYLESHEET_FILE = |
RTF_EXTENSIONS_FILE = |
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
+# with syntax highlighting in the RTF output. |
+# |
+# Note that which sources are shown also depends on other settings such as |
+# SOURCE_BROWSER. |
+# The default value is: NO. |
+# This tag requires that the tag GENERATE_RTF is set to YES. |
+ |
+RTF_SOURCE_CODE = NO |
+ |
#--------------------------------------------------------------------------- |
# Configuration options related to the man page output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for |
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for |
# classes and files. |
# The default value is: NO. |
@@ -1795,7 +1830,7 @@ MAN_LINKS = NO |
# Configuration options related to the XML output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that |
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that |
# captures the structure of the code including all documentation. |
# The default value is: NO. |
@@ -1809,7 +1844,7 @@ GENERATE_XML = NO |
XML_OUTPUT = xml |
-# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program |
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program |
# listings (including syntax highlighting and cross-referencing information) to |
# the XML output. Note that enabling this will significantly increase the size |
# of the XML output. |
@@ -1822,7 +1857,7 @@ XML_PROGRAMLISTING = YES |
# Configuration options related to the DOCBOOK output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files |
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files |
# that can be used to generate PDF. |
# The default value is: NO. |
@@ -1836,14 +1871,23 @@ GENERATE_DOCBOOK = NO |
DOCBOOK_OUTPUT = docbook |
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the |
+# program listings (including syntax highlighting and cross-referencing |
+# information) to the DOCBOOK output. Note that enabling this will significantly |
+# increase the size of the DOCBOOK output. |
+# The default value is: NO. |
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES. |
+ |
+DOCBOOK_PROGRAMLISTING = NO |
+ |
#--------------------------------------------------------------------------- |
# Configuration options for the AutoGen Definitions output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen |
-# Definitions (see http://autogen.sf.net) file that captures the structure of |
-# the code including all documentation. Note that this feature is still |
-# experimental and incomplete at the moment. |
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
+# AutoGen Definitions (see http://autogen.sf.net) file that captures the |
+# structure of the code including all documentation. Note that this feature is |
+# still experimental and incomplete at the moment. |
# The default value is: NO. |
GENERATE_AUTOGEN_DEF = NO |
@@ -1852,7 +1896,7 @@ GENERATE_AUTOGEN_DEF = NO |
# Configuration options related to the Perl module output |
#--------------------------------------------------------------------------- |
-# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module |
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module |
# file that captures the structure of the code including all documentation. |
# |
# Note that this feature is still experimental and incomplete at the moment. |
@@ -1860,7 +1904,7 @@ GENERATE_AUTOGEN_DEF = NO |
GENERATE_PERLMOD = NO |
-# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary |
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary |
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI |
# output from the Perl module output. |
# The default value is: NO. |
@@ -1868,9 +1912,9 @@ GENERATE_PERLMOD = NO |
PERLMOD_LATEX = NO |
-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely |
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely |
# formatted so it can be parsed by a human reader. This is useful if you want to |
-# understand what is going on. On the other hand, if this tag is set to NO the |
+# understand what is going on. On the other hand, if this tag is set to NO, the |
# size of the Perl module output will be much smaller and Perl will parse it |
# just the same. |
# The default value is: YES. |
@@ -1890,14 +1934,14 @@ PERLMOD_MAKEVAR_PREFIX = |
# Configuration options related to the preprocessor |
#--------------------------------------------------------------------------- |
-# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all |
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all |
# C-preprocessor directives found in the sources and include files. |
# The default value is: YES. |
ENABLE_PREPROCESSING = YES |
-# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names |
-# in the source code. If set to NO only conditional compilation will be |
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names |
+# in the source code. If set to NO, only conditional compilation will be |
# performed. Macro expansion can be done in a controlled way by setting |
# EXPAND_ONLY_PREDEF to YES. |
# The default value is: NO. |
@@ -1913,7 +1957,7 @@ MACRO_EXPANSION = YES |
EXPAND_ONLY_PREDEF = YES |
-# If the SEARCH_INCLUDES tag is set to YES the includes files in the |
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the |
# INCLUDE_PATH will be searched if a #include is found. |
# The default value is: YES. |
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
@@ -1990,20 +2034,21 @@ TAGFILES = |
GENERATE_TAGFILE = |
-# If the ALLEXTERNALS tag is set to YES all external class will be listed in the |
-# class index. If set to NO only the inherited external classes will be listed. |
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
+# the class index. If set to NO, only the inherited external classes will be |
+# listed. |
# The default value is: NO. |
ALLEXTERNALS = NO |
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in |
-# the modules index. If set to NO, only the current project's groups will be |
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
+# in the modules index. If set to NO, only the current project's groups will be |
# listed. |
# The default value is: YES. |
EXTERNAL_GROUPS = YES |
-# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in |
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in |
# the related pages index. If set to NO, only the current project's pages will |
# be listed. |
# The default value is: YES. |
@@ -2020,7 +2065,7 @@ PERL_PATH = /usr/bin/perl |
# Configuration options related to the dot tool |
#--------------------------------------------------------------------------- |
-# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram |
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram |
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to |
# NO turns the diagrams off. Note that this option also works with HAVE_DOT |
# disabled, but it is recommended to install and use dot, since it yields more |
@@ -2045,7 +2090,7 @@ MSCGEN_PATH = |
DIA_PATH = |
-# If set to YES, the inheritance and collaboration graphs will hide inheritance |
+# If set to YES the inheritance and collaboration graphs will hide inheritance |
# and usage relations if the target is undocumented or is not a class. |
# The default value is: YES. |
@@ -2070,7 +2115,7 @@ HAVE_DOT = NO |
DOT_NUM_THREADS = 0 |
-# When you want a differently looking font n the dot files that doxygen |
+# When you want a differently looking font in the dot files that doxygen |
# generates you can specify the font name using DOT_FONTNAME. You 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 |
@@ -2118,7 +2163,7 @@ COLLABORATION_GRAPH = YES |
GROUP_GRAPHS = YES |
-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and |
# collaboration diagrams in a style similar to the OMG's Unified Modeling |
# Language. |
# The default value is: NO. |
@@ -2251,6 +2296,19 @@ MSCFILE_DIRS = |
DIAFILE_DIRS = |
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
+# path where java can find the plantuml.jar file. If left blank, it is assumed |
+# PlantUML is not used or called during a preprocessing step. Doxygen will |
+# generate a warning when it encounters a \startuml command in this case and |
+# will not generate output for the diagram. |
+ |
+PLANTUML_JAR_PATH = |
+ |
+# When using plantuml, the specified paths are searched for files specified by |
+# the !include statement in a plantuml block. |
+ |
+PLANTUML_INCLUDE_PATH = |
+ |
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
# that will be shown in the graph. If the number of nodes in a graph becomes |
# larger than this value, doxygen will truncate the graph, which is visualized |
@@ -2287,7 +2345,7 @@ MAX_DOT_GRAPH_DEPTH = 0 |
DOT_TRANSPARENT = NO |
-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output |
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
# files in one run (i.e. multiple -o and -T options on the command line). This |
# makes dot run faster, but since only newer versions of dot (>1.8.10) support |
# this, this feature is disabled by default. |
@@ -2304,7 +2362,7 @@ DOT_MULTI_TARGETS = NO |
GENERATE_LEGEND = YES |
-# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot |
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot |
# files that are used to generate the various graphs. |
# The default value is: YES. |
# This tag requires that the tag HAVE_DOT is set to YES. |