Skip to content

Commit 63e49e5

Browse files
authored
doxyfile: fix(typo): some 'option's shouldn't be 'options'
1 parent 2079470 commit 63e49e5

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

Doxyfile

+40-40
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ OUTPUT_DIRECTORY = doc
6363
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
6565
# 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
6767
# putting all generated files in the same directory would otherwise causes
6868
# performance problems for the file system.
6969
# The default value is: NO.
@@ -330,7 +330,7 @@ AUTOLINK_SUPPORT = YES
330330

331331
BUILTIN_STL_SUPPORT = NO
332332

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
334334
# enable parsing support.
335335
# The default value is: NO.
336336

@@ -345,11 +345,11 @@ CPP_CLI_SUPPORT = NO
345345
SIP_SUPPORT = NO
346346

347347
# 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
349349
# doxygen to replace the get and set methods by a property in the documentation.
350350
# This will only work if the methods are indeed getting or setting a simple
351351
# 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.
353353
# The default value is: YES.
354354

355355
IDL_PROPERTY_SUPPORT = YES
@@ -362,8 +362,8 @@ IDL_PROPERTY_SUPPORT = YES
362362

363363
DISTRIBUTE_GROUP_DOC = NO
364364

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
367367
# is disabled and one has to add nested compounds explicitly via \ingroup.
368368
# The default value is: NO.
369369

@@ -483,14 +483,14 @@ EXTRACT_ANON_NSPACES = NO
483483
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
484484
# undocumented members inside documented classes or files. If set to NO these
485485
# 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.
487487
# The default value is: NO.
488488

489489
HIDE_UNDOC_MEMBERS = NO
490490

491491
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
492492
# 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
494494
# has no effect if EXTRACT_ALL is enabled.
495495
# The default value is: NO.
496496

@@ -521,7 +521,7 @@ INTERNAL_DOCS = NO
521521
# names in lower-case letters. If set to YES, upper-case letters are also
522522
# allowed. This is useful if you have classes or files whose names only differ
523523
# 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.
525525
# The default value is: system dependent.
526526

527527
CASE_SENSE_NAMES = NO
@@ -584,9 +584,9 @@ SORT_BRIEF_DOCS = NO
584584
# (brief and detailed) documentation of class members so that constructors and
585585
# destructors are listed first. If set to NO the constructors will appear in the
586586
# 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
588588
# 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
590590
# detailed member documentation.
591591
# The default value is: NO.
592592

@@ -602,14 +602,14 @@ SORT_GROUP_NAMES = NO
602602
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
603603
# fully-qualified names, including namespaces. If set to NO, the class list will
604604
# 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
607607
# list.
608608
# The default value is: NO.
609609

610610
SORT_BY_SCOPE_NAME = NO
611611

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
613613
# type resolution of all parameters of a function it will reject a match between
614614
# the prototype and the implementation of a member function even if there is
615615
# only one candidate or it is obvious which candidate to choose by doing a
@@ -695,8 +695,8 @@ FILE_VERSION_FILTER =
695695
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
696696
# by doxygen. The layout file controls the global structure of the generated
697697
# 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
700700
# will be used as the name of the layout file.
701701
#
702702
# Note that if you run doxygen from a directory containing a file called
@@ -750,7 +750,7 @@ WARN_IF_UNDOCUMENTED = YES
750750

751751
WARN_IF_DOC_ERROR = YES
752752

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
754754
# are documented, but have no documentation for their parameters or return
755755
# value. If set to NO, doxygen will only warn about wrong or incomplete
756756
# parameter documentation, but not about the absence of documentation.
@@ -1036,8 +1036,8 @@ VERBATIM_HEADERS = YES
10361036
# cost of reduced performance. This can be particularly helpful with template
10371037
# rich C++ code for which doxygen's built-in parser lacks the necessary type
10381038
# 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.
10411041
# The default value is: NO.
10421042

10431043
CLANG_ASSISTED_PARSING = NO
@@ -1144,7 +1144,7 @@ HTML_STYLESHEET =
11441144

11451145
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
11461146
# 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.
11481148
# This is preferred over using HTML_STYLESHEET since it does not replace the
11491149
# standard style sheet and is therefore more robust against future updates.
11501150
# Doxygen will copy the style sheet files to the output directory.
@@ -1418,7 +1418,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
14181418
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
14191419
# of each HTML page. A value of NO enables the index and the value YES disables
14201420
# 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.
14221422
# The default value is: NO.
14231423
# This tag requires that the tag GENERATE_HTML is set to YES.
14241424

@@ -1435,7 +1435,7 @@ DISABLE_INDEX = NO
14351435
# sheet generated by doxygen has an example that shows how to put an image at
14361436
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
14371437
# 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.
14391439
# The default value is: NO.
14401440
# This tag requires that the tag GENERATE_HTML is set to YES.
14411441

@@ -1458,7 +1458,7 @@ ENUM_VALUES_PER_LINE = 4
14581458

14591459
TREEVIEW_WIDTH = 250
14601460

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
14621462
# external symbols imported via tag files in a separate window.
14631463
# The default value is: NO.
14641464
# This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1478,19 +1478,19 @@ FORMULA_FONTSIZE = 10
14781478
# generated for formulas are transparent PNGs. Transparent PNGs are not
14791479
# supported properly for IE 6.0, but are supported on all modern browsers.
14801480
#
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
14821482
# the HTML output directory before the changes have effect.
14831483
# The default value is: YES.
14841484
# This tag requires that the tag GENERATE_HTML is set to YES.
14851485

14861486
FORMULA_TRANSPARENT = YES
14871487

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
14891489
# http://www.mathjax.org) which uses client side Javascript for the rendering
14901490
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
14911491
# installed or if you want to formulas look prettier in the HTML output. When
14921492
# 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.
14941494
# The default value is: NO.
14951495
# This tag requires that the tag GENERATE_HTML is set to YES.
14961496

@@ -1507,7 +1507,7 @@ USE_MATHJAX = NO
15071507
MATHJAX_FORMAT = HTML-CSS
15081508

15091509
# 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
15111511
# should contain the MathJax.js script. For instance, if the mathjax directory
15121512
# is located at the same level as the HTML output directory, then
15131513
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
@@ -1570,7 +1570,7 @@ SERVER_BASED_SEARCH = NO
15701570
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
15711571
# script for searching. Instead the search results are written to an XML file
15721572
# 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
15741574
# search results.
15751575
#
15761576
# Doxygen ships with an example indexer (doxyindexer) and search engine
@@ -1640,7 +1640,7 @@ LATEX_OUTPUT = latex
16401640
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
16411641
# invoked.
16421642
#
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
16441644
# bitmaps for formulas in the HTML output, but not in the Makefile that is
16451645
# written to the output directory.
16461646
# The default file is: latex.
@@ -1677,7 +1677,7 @@ PAPER_TYPE = a4
16771677
# by its name or with the correct syntax as to be used with the LaTeX
16781678
# \usepackage command. To get the times font for instance you can specify :
16791679
# 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:
16811681
# EXTRA_PACKAGES=[intlimits]{amsmath}
16821682
# If left blank no extra packages will be included.
16831683
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1713,7 +1713,7 @@ LATEX_FOOTER =
17131713

17141714
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
17151715
# 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
17171717
# will copy the style sheet files to the output directory.
17181718
# Note: The order of the extra style sheet files is of importance (e.g. the last
17191719
# style sheet in the list overrules the setting of the previous ones in the
@@ -1740,7 +1740,7 @@ LATEX_EXTRA_FILES =
17401740
PDF_HYPERLINKS = YES
17411741

17421742
# 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
17441744
# higher quality PDF documentation.
17451745
# The default value is: YES.
17461746
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1749,7 +1749,7 @@ USE_PDFLATEX = YES
17491749

17501750
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
17511751
# 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
17531753
# when generating formulas in HTML.
17541754
# The default value is: NO.
17551755
# This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -2139,7 +2139,7 @@ PERL_PATH = /usr/bin/perl
21392139

21402140
# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
21412141
# (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
21432143
# disabled, but it is recommended to install and use dot, since it yields more
21442144
# powerful graphs.
21452145
# The default value is: YES.
@@ -2171,7 +2171,7 @@ HIDE_UNDOC_RELATIONS = YES
21712171
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
21722172
# available from the path. This tool is part of Graphviz (see:
21732173
# 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
21752175
# set to NO
21762176
# The default value is: NO.
21772177

@@ -2285,7 +2285,7 @@ INCLUDED_BY_GRAPH = YES
22852285
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
22862286
# dependency graph for every global function or class method.
22872287
#
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.
22892289
# So in most cases it will be better to enable call graphs for selected
22902290
# functions only using the \callgraph command. Disabling a call graph can be
22912291
# accomplished by means of the command \hidecallgraph.
@@ -2297,7 +2297,7 @@ CALL_GRAPH = NO
22972297
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
22982298
# dependency graph for every global function or class method.
22992299
#
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.
23012301
# So in most cases it will be better to enable caller graphs for selected
23022302
# functions only using the \callergraph command. Disabling a caller graph can be
23032303
# accomplished by means of the command \hidecallergraph.
@@ -2337,7 +2337,7 @@ DIRECTORY_GRAPH = YES
23372337

23382338
DOT_IMAGE_FORMAT = png
23392339

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
23412341
# enable generation of interactive SVG images that allow zooming and panning.
23422342
#
23432343
# Note that this requires a modern browser other than Internet Explorer. Tested
@@ -2407,7 +2407,7 @@ DOT_GRAPH_MAX_NODES = 50
24072407
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
24082408
# generated by dot. A depth value of 3 means that only nodes reachable from the
24092409
# 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
24112411
# or 2 may greatly reduce the computation time needed for large code bases. Also
24122412
# note that the size of a graph can be further restricted by
24132413
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
@@ -2420,7 +2420,7 @@ MAX_DOT_GRAPH_DEPTH = 0
24202420
# background. This is disabled by default, because dot on Windows does not seem
24212421
# to support this out of the box.
24222422
#
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
24242424
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
24252425
# read).
24262426
# The default value is: NO.

0 commit comments

Comments
 (0)