@@ -63,7 +63,7 @@ OUTPUT_DIRECTORY = doc
63
63
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64
64
# directories (in 2 levels) under the output directory of each output format and
65
65
# will distribute the generated files over these directories. Enabling this
66
- # options can be useful when feeding doxygen a huge amount of source files, where
66
+ # option can be useful when feeding doxygen a huge amount of source files, where
67
67
# putting all generated files in the same directory would otherwise causes
68
68
# performance problems for the file system.
69
69
# The default value is: NO.
@@ -330,7 +330,7 @@ AUTOLINK_SUPPORT = YES
330
330
331
331
BUILTIN_STL_SUPPORT = NO
332
332
333
- # If you use Microsoft's C++/CLI language, you should set this options to YES to
333
+ # If you use Microsoft's C++/CLI language, you should set this option to YES to
334
334
# enable parsing support.
335
335
# The default value is: NO.
336
336
@@ -345,11 +345,11 @@ CPP_CLI_SUPPORT = NO
345
345
SIP_SUPPORT = NO
346
346
347
347
# For Microsoft's IDL there are propget and propput attributes to indicate
348
- # getter and setter methods for a property. Setting this options to YES will make
348
+ # getter and setter methods for a property. Setting this option to YES will make
349
349
# doxygen to replace the get and set methods by a property in the documentation.
350
350
# This will only work if the methods are indeed getting or setting a simple
351
351
# type. If this is not the case, or you want to show the methods anyway, you
352
- # should set this options to NO.
352
+ # should set this option to NO.
353
353
# The default value is: YES.
354
354
355
355
IDL_PROPERTY_SUPPORT = YES
@@ -362,8 +362,8 @@ IDL_PROPERTY_SUPPORT = YES
362
362
363
363
DISTRIBUTE_GROUP_DOC = NO
364
364
365
- # If one adds a struct or class to a group and this options is enabled, then also
366
- # any nested class or struct is added to the same group. By default this options
365
+ # If one adds a struct or class to a group and this option is enabled, then also
366
+ # any nested class or struct is added to the same group. By default this option
367
367
# is disabled and one has to add nested compounds explicitly via \ingroup.
368
368
# The default value is: NO.
369
369
@@ -483,14 +483,14 @@ EXTRACT_ANON_NSPACES = NO
483
483
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
484
484
# undocumented members inside documented classes or files. If set to NO these
485
485
# members will be included in the various overviews, but no documentation
486
- # section is generated. This options has no effect if EXTRACT_ALL is enabled.
486
+ # section is generated. This option has no effect if EXTRACT_ALL is enabled.
487
487
# The default value is: NO.
488
488
489
489
HIDE_UNDOC_MEMBERS = NO
490
490
491
491
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
492
492
# undocumented classes that are normally visible in the class hierarchy. If set
493
- # to NO, these classes will be included in the various overviews. This options
493
+ # to NO, these classes will be included in the various overviews. This option
494
494
# has no effect if EXTRACT_ALL is enabled.
495
495
# The default value is: NO.
496
496
@@ -521,7 +521,7 @@ INTERNAL_DOCS = NO
521
521
# names in lower-case letters. If set to YES, upper-case letters are also
522
522
# allowed. This is useful if you have classes or files whose names only differ
523
523
# in case and if your file system supports case sensitive file names. Windows
524
- # and Mac users are advised to set this options to NO.
524
+ # and Mac users are advised to set this option to NO.
525
525
# The default value is: system dependent.
526
526
527
527
CASE_SENSE_NAMES = NO
@@ -584,9 +584,9 @@ SORT_BRIEF_DOCS = NO
584
584
# (brief and detailed) documentation of class members so that constructors and
585
585
# destructors are listed first. If set to NO the constructors will appear in the
586
586
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
587
- # Note: If SORT_BRIEF_DOCS is set to NO this options is ignored for sorting brief
587
+ # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
588
588
# member documentation.
589
- # Note: If SORT_MEMBER_DOCS is set to NO this options is ignored for sorting
589
+ # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
590
590
# detailed member documentation.
591
591
# The default value is: NO.
592
592
@@ -602,14 +602,14 @@ SORT_GROUP_NAMES = NO
602
602
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
603
603
# fully-qualified names, including namespaces. If set to NO, the class list will
604
604
# be sorted only by class name, not including the namespace part.
605
- # Note: This options is not very useful if HIDE_SCOPE_NAMES is set to YES.
606
- # Note: This options applies only to the class list, not to the alphabetical
605
+ # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
606
+ # Note: This option applies only to the class list, not to the alphabetical
607
607
# list.
608
608
# The default value is: NO.
609
609
610
610
SORT_BY_SCOPE_NAME = NO
611
611
612
- # If the STRICT_PROTO_MATCHING options is enabled and doxygen fails to do proper
612
+ # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
613
613
# type resolution of all parameters of a function it will reject a match between
614
614
# the prototype and the implementation of a member function even if there is
615
615
# only one candidate or it is obvious which candidate to choose by doing a
@@ -695,8 +695,8 @@ FILE_VERSION_FILTER =
695
695
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
696
696
# by doxygen. The layout file controls the global structure of the generated
697
697
# output files in an output format independent way. To create the layout file
698
- # that represents doxygen's defaults, run doxygen with the -l options . You can
699
- # optionally specify a file name after the options , if omitted DoxygenLayout.xml
698
+ # that represents doxygen's defaults, run doxygen with the -l option . You can
699
+ # optionally specify a file name after the option , if omitted DoxygenLayout.xml
700
700
# will be used as the name of the layout file.
701
701
#
702
702
# Note that if you run doxygen from a directory containing a file called
@@ -750,7 +750,7 @@ WARN_IF_UNDOCUMENTED = YES
750
750
751
751
WARN_IF_DOC_ERROR = YES
752
752
753
- # This WARN_NO_PARAMDOC options can be enabled to get warnings for functions that
753
+ # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
754
754
# are documented, but have no documentation for their parameters or return
755
755
# value. If set to NO, doxygen will only warn about wrong or incomplete
756
756
# parameter documentation, but not about the absence of documentation.
@@ -1036,8 +1036,8 @@ VERBATIM_HEADERS = YES
1036
1036
# cost of reduced performance. This can be particularly helpful with template
1037
1037
# rich C++ code for which doxygen's built-in parser lacks the necessary type
1038
1038
# information.
1039
- # Note: The availability of this options depends on whether or not doxygen was
1040
- # generated with the -Duse-libclang=ON options for CMake.
1039
+ # Note: The availability of this option depends on whether or not doxygen was
1040
+ # generated with the -Duse-libclang=ON option for CMake.
1041
1041
# The default value is: NO.
1042
1042
1043
1043
CLANG_ASSISTED_PARSING = NO
@@ -1144,7 +1144,7 @@ HTML_STYLESHEET =
1144
1144
1145
1145
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1146
1146
# cascading style sheets that are included after the standard style sheets
1147
- # created by doxygen. Using this options one can overrule certain style aspects.
1147
+ # created by doxygen. Using this option one can overrule certain style aspects.
1148
1148
# This is preferred over using HTML_STYLESHEET since it does not replace the
1149
1149
# standard style sheet and is therefore more robust against future updates.
1150
1150
# Doxygen will copy the style sheet files to the output directory.
@@ -1418,7 +1418,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
1418
1418
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1419
1419
# of each HTML page. A value of NO enables the index and the value YES disables
1420
1420
# it. Since the tabs in the index contain the same information as the navigation
1421
- # tree, you can set this options to YES if you also set GENERATE_TREEVIEW to YES.
1421
+ # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1422
1422
# The default value is: NO.
1423
1423
# This tag requires that the tag GENERATE_HTML is set to YES.
1424
1424
@@ -1435,7 +1435,7 @@ DISABLE_INDEX = NO
1435
1435
# sheet generated by doxygen has an example that shows how to put an image at
1436
1436
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1437
1437
# the same information as the tab index, you could consider setting
1438
- # DISABLE_INDEX to YES when enabling this options .
1438
+ # DISABLE_INDEX to YES when enabling this option .
1439
1439
# The default value is: NO.
1440
1440
# This tag requires that the tag GENERATE_HTML is set to YES.
1441
1441
@@ -1458,7 +1458,7 @@ ENUM_VALUES_PER_LINE = 4
1458
1458
1459
1459
TREEVIEW_WIDTH = 250
1460
1460
1461
- # If the EXT_LINKS_IN_WINDOW options is set to YES, doxygen will open links to
1461
+ # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1462
1462
# external symbols imported via tag files in a separate window.
1463
1463
# The default value is: NO.
1464
1464
# This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1478,19 +1478,19 @@ FORMULA_FONTSIZE = 10
1478
1478
# generated for formulas are transparent PNGs. Transparent PNGs are not
1479
1479
# supported properly for IE 6.0, but are supported on all modern browsers.
1480
1480
#
1481
- # Note that when changing this options you need to delete any form_*.png files in
1481
+ # Note that when changing this option you need to delete any form_*.png files in
1482
1482
# the HTML output directory before the changes have effect.
1483
1483
# The default value is: YES.
1484
1484
# This tag requires that the tag GENERATE_HTML is set to YES.
1485
1485
1486
1486
FORMULA_TRANSPARENT = YES
1487
1487
1488
- # Enable the USE_MATHJAX options to render LaTeX formulas using MathJax (see
1488
+ # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1489
1489
# http://www.mathjax.org) which uses client side Javascript for the rendering
1490
1490
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1491
1491
# installed or if you want to formulas look prettier in the HTML output. When
1492
1492
# enabled you may also need to install MathJax separately and configure the path
1493
- # to it using the MATHJAX_RELPATH options .
1493
+ # to it using the MATHJAX_RELPATH option .
1494
1494
# The default value is: NO.
1495
1495
# This tag requires that the tag GENERATE_HTML is set to YES.
1496
1496
@@ -1507,7 +1507,7 @@ USE_MATHJAX = NO
1507
1507
MATHJAX_FORMAT = HTML-CSS
1508
1508
1509
1509
# When MathJax is enabled you need to specify the location relative to the HTML
1510
- # output directory using the MATHJAX_RELPATH options . The destination directory
1510
+ # output directory using the MATHJAX_RELPATH option . The destination directory
1511
1511
# should contain the MathJax.js script. For instance, if the mathjax directory
1512
1512
# is located at the same level as the HTML output directory, then
1513
1513
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
@@ -1570,7 +1570,7 @@ SERVER_BASED_SEARCH = NO
1570
1570
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1571
1571
# script for searching. Instead the search results are written to an XML file
1572
1572
# which needs to be processed by an external indexer. Doxygen will invoke an
1573
- # external search engine pointed to by the SEARCHENGINE_URL options to obtain the
1573
+ # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1574
1574
# search results.
1575
1575
#
1576
1576
# Doxygen ships with an example indexer (doxyindexer) and search engine
@@ -1640,7 +1640,7 @@ LATEX_OUTPUT = latex
1640
1640
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1641
1641
# invoked.
1642
1642
#
1643
- # Note that when enabling USE_PDFLATEX this options is only used for generating
1643
+ # Note that when enabling USE_PDFLATEX this option is only used for generating
1644
1644
# bitmaps for formulas in the HTML output, but not in the Makefile that is
1645
1645
# written to the output directory.
1646
1646
# The default file is: latex.
@@ -1677,7 +1677,7 @@ PAPER_TYPE = a4
1677
1677
# by its name or with the correct syntax as to be used with the LaTeX
1678
1678
# \usepackage command. To get the times font for instance you can specify :
1679
1679
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1680
- # To use the options intlimits with the amsmath package you can specify:
1680
+ # To use the option intlimits with the amsmath package you can specify:
1681
1681
# EXTRA_PACKAGES=[intlimits]{amsmath}
1682
1682
# If left blank no extra packages will be included.
1683
1683
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1713,7 +1713,7 @@ LATEX_FOOTER =
1713
1713
1714
1714
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1715
1715
# LaTeX style sheets that are included after the standard style sheets created
1716
- # by doxygen. Using this options one can overrule certain style aspects. Doxygen
1716
+ # by doxygen. Using this option one can overrule certain style aspects. Doxygen
1717
1717
# will copy the style sheet files to the output directory.
1718
1718
# Note: The order of the extra style sheet files is of importance (e.g. the last
1719
1719
# style sheet in the list overrules the setting of the previous ones in the
@@ -1740,7 +1740,7 @@ LATEX_EXTRA_FILES =
1740
1740
PDF_HYPERLINKS = YES
1741
1741
1742
1742
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1743
- # the PDF file directly from the LaTeX files. Set this options to YES, to get a
1743
+ # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1744
1744
# higher quality PDF documentation.
1745
1745
# The default value is: YES.
1746
1746
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1749,7 +1749,7 @@ USE_PDFLATEX = YES
1749
1749
1750
1750
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1751
1751
# command to the generated LaTeX files. This will instruct LaTeX to keep running
1752
- # if errors occur, instead of asking the user for help. This options is also used
1752
+ # if errors occur, instead of asking the user for help. This option is also used
1753
1753
# when generating formulas in HTML.
1754
1754
# The default value is: NO.
1755
1755
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -2139,7 +2139,7 @@ PERL_PATH = /usr/bin/perl
2139
2139
2140
2140
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2141
2141
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2142
- # NO turns the diagrams off. Note that this options also works with HAVE_DOT
2142
+ # NO turns the diagrams off. Note that this option also works with HAVE_DOT
2143
2143
# disabled, but it is recommended to install and use dot, since it yields more
2144
2144
# powerful graphs.
2145
2145
# The default value is: YES.
@@ -2171,7 +2171,7 @@ HIDE_UNDOC_RELATIONS = YES
2171
2171
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2172
2172
# available from the path. This tool is part of Graphviz (see:
2173
2173
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2174
- # Bell Labs. The other options in this section have no effect if this options is
2174
+ # Bell Labs. The other options in this section have no effect if this option is
2175
2175
# set to NO
2176
2176
# The default value is: NO.
2177
2177
@@ -2285,7 +2285,7 @@ INCLUDED_BY_GRAPH = YES
2285
2285
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2286
2286
# dependency graph for every global function or class method.
2287
2287
#
2288
- # Note that enabling this options will significantly increase the time of a run.
2288
+ # Note that enabling this option will significantly increase the time of a run.
2289
2289
# So in most cases it will be better to enable call graphs for selected
2290
2290
# functions only using the \callgraph command. Disabling a call graph can be
2291
2291
# accomplished by means of the command \hidecallgraph.
@@ -2297,7 +2297,7 @@ CALL_GRAPH = NO
2297
2297
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2298
2298
# dependency graph for every global function or class method.
2299
2299
#
2300
- # Note that enabling this options will significantly increase the time of a run.
2300
+ # Note that enabling this option will significantly increase the time of a run.
2301
2301
# So in most cases it will be better to enable caller graphs for selected
2302
2302
# functions only using the \callergraph command. Disabling a caller graph can be
2303
2303
# accomplished by means of the command \hidecallergraph.
@@ -2337,7 +2337,7 @@ DIRECTORY_GRAPH = YES
2337
2337
2338
2338
DOT_IMAGE_FORMAT = png
2339
2339
2340
- # If DOT_IMAGE_FORMAT is set to svg, then this options can be set to YES to
2340
+ # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2341
2341
# enable generation of interactive SVG images that allow zooming and panning.
2342
2342
#
2343
2343
# Note that this requires a modern browser other than Internet Explorer. Tested
@@ -2407,7 +2407,7 @@ DOT_GRAPH_MAX_NODES = 50
2407
2407
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2408
2408
# generated by dot. A depth value of 3 means that only nodes reachable from the
2409
2409
# root by following a path via at most 3 edges will be shown. Nodes that lay
2410
- # further from the root node will be omitted. Note that setting this options to 1
2410
+ # further from the root node will be omitted. Note that setting this option to 1
2411
2411
# or 2 may greatly reduce the computation time needed for large code bases. Also
2412
2412
# note that the size of a graph can be further restricted by
2413
2413
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
@@ -2420,7 +2420,7 @@ MAX_DOT_GRAPH_DEPTH = 0
2420
2420
# background. This is disabled by default, because dot on Windows does not seem
2421
2421
# to support this out of the box.
2422
2422
#
2423
- # Warning: Depending on the platform used, enabling this options may lead to
2423
+ # Warning: Depending on the platform used, enabling this option may lead to
2424
2424
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2425
2425
# read).
2426
2426
# The default value is: NO.
0 commit comments