Skip to content

Commit 2484e2e

Browse files
committed
update Doxygen config with doxygen -u
1 parent 8ca6144 commit 2484e2e

File tree

1 file changed

+118
-51
lines changed

1 file changed

+118
-51
lines changed

Doxyfile

Lines changed: 118 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.8.18
1+
# Doxyfile 1.9.1
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "utf8proc"
35+
PROJECT_NAME = utf8proc
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -217,6 +217,14 @@ QT_AUTOBRIEF = NO
217217

218218
MULTILINE_CPP_IS_BRIEF = NO
219219

220+
# By default Python docstrings are displayed as preformatted text and doxygen's
221+
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
222+
# doxygen's special commands can be used and the contents of the docstring
223+
# documentation blocks is shown as doxygen documentation.
224+
# The default value is: YES.
225+
226+
PYTHON_DOCSTRING = YES
227+
220228
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
221229
# documentation from any documented member that it re-implements.
222230
# The default value is: YES.
@@ -305,7 +313,10 @@ OPTIMIZE_OUTPUT_SLICE = NO
305313
# Note: For files without extension you can use no_extension as a placeholder.
306314
#
307315
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
308-
# the files are not read by doxygen.
316+
# the files are not read by doxygen. When specifying no_extension you should add
317+
# * to the FILE_PATTERNS.
318+
#
319+
# Note see also the list of default file extension mappings.
309320

310321
EXTENSION_MAPPING =
311322

@@ -439,6 +450,19 @@ TYPEDEF_HIDES_STRUCT = NO
439450

440451
LOOKUP_CACHE_SIZE = 0
441452

453+
# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
454+
# during processing. When set to 0 doxygen will based this on the number of
455+
# cores available in the system. You can set it explicitly to a value larger
456+
# than 0 to get more control over the balance between CPU load and processing
457+
# speed. At this moment only the input processing can be done using multiple
458+
# threads. Since this is still an experimental feature the default is set to 1,
459+
# which efficively disables parallel processing. Please report any issues you
460+
# encounter. Generating dot graphs in parallel is controlled by the
461+
# DOT_NUM_THREADS setting.
462+
# Minimum value: 0, maximum value: 32, default value: 1.
463+
464+
NUM_PROC_THREADS = 1
465+
442466
#---------------------------------------------------------------------------
443467
# Build related configuration options
444468
#---------------------------------------------------------------------------
@@ -502,6 +526,13 @@ EXTRACT_LOCAL_METHODS = NO
502526

503527
EXTRACT_ANON_NSPACES = NO
504528

529+
# If this flag is set to YES, the name of an unnamed parameter in a declaration
530+
# will be determined by the corresponding definition. By default unnamed
531+
# parameters remain unnamed in the output.
532+
# The default value is: YES.
533+
534+
RESOLVE_UNNAMED_PARAMS = YES
535+
505536
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
506537
# undocumented members inside documented classes or files. If set to NO these
507538
# members will be included in the various overviews, but no documentation
@@ -539,11 +570,18 @@ HIDE_IN_BODY_DOCS = NO
539570

540571
INTERNAL_DOCS = NO
541572

542-
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
543-
# names in lower-case letters. If set to YES, upper-case letters are also
544-
# allowed. This is useful if you have classes or files whose names only differ
545-
# in case and if your file system supports case sensitive file names. Windows
546-
# (including Cygwin) ands Mac users are advised to set this option to NO.
573+
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
574+
# able to match the capabilities of the underlying filesystem. In case the
575+
# filesystem is case sensitive (i.e. it supports files in the same directory
576+
# whose names only differ in casing), the option must be set to YES to properly
577+
# deal with such files in case they appear in the input. For filesystems that
578+
# are not case sensitive the option should be be set to NO to properly deal with
579+
# output files written for symbols that only differ in casing, such as for two
580+
# classes, one named CLASS and the other named Class, and to also support
581+
# references to files without having to specify the exact matching casing. On
582+
# Windows (including Cygwin) and MacOS, users should typically set this option
583+
# to NO, whereas on Linux or other Unix flavors it should typically be set to
584+
# YES.
547585
# The default value is: system dependent.
548586

549587
CASE_SENSE_NAMES = NO
@@ -782,7 +820,10 @@ WARN_IF_DOC_ERROR = YES
782820
WARN_NO_PARAMDOC = NO
783821

784822
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
785-
# a warning is encountered.
823+
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
824+
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
825+
# at the end of the doxygen process doxygen will return with a non-zero status.
826+
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
786827
# The default value is: NO.
787828

788829
WARN_AS_ERROR = NO
@@ -818,8 +859,8 @@ INPUT =
818859
# This tag can be used to specify the character encoding of the source files
819860
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
820861
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
821-
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
822-
# possible encodings.
862+
# documentation (see:
863+
# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
823864
# The default value is: UTF-8.
824865

825866
INPUT_ENCODING = UTF-8
@@ -832,13 +873,15 @@ INPUT_ENCODING = UTF-8
832873
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
833874
# read by doxygen.
834875
#
876+
# Note the list of default checked file patterns might differ from the list of
877+
# default file extension mappings.
878+
#
835879
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
836880
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
837881
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
838882
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
839-
# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
840-
# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
841-
# *.vhdl, *.ucf, *.qsf and *.ice.
883+
# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
884+
# *.ucf, *.qsf and *.ice.
842885

843886
FILE_PATTERNS =
844887

@@ -1065,13 +1108,6 @@ VERBATIM_HEADERS = YES
10651108

10661109
ALPHABETICAL_INDEX = YES
10671110

1068-
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1069-
# which the alphabetical index list will be split.
1070-
# Minimum value: 1, maximum value: 20, default value: 5.
1071-
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1072-
1073-
COLS_IN_ALPHA_INDEX = 5
1074-
10751111
# In case all classes in a project start with a common prefix, all classes will
10761112
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
10771113
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -1242,10 +1278,11 @@ HTML_INDEX_NUM_ENTRIES = 100
12421278

12431279
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
12441280
# generated that can be used as input for Apple's Xcode 3 integrated development
1245-
# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1246-
# 10.5 (Leopard). To create a documentation set, doxygen will generate a
1247-
# Makefile in the HTML output directory. Running make will produce the docset in
1248-
# that directory and running make install will install the docset in
1281+
# environment (see:
1282+
# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1283+
# create a documentation set, doxygen will generate a Makefile in the HTML
1284+
# output directory. Running make will produce the docset in that directory and
1285+
# running make install will install the docset in
12491286
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
12501287
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
12511288
# genXcode/_index.html for more information.
@@ -1287,8 +1324,8 @@ DOCSET_PUBLISHER_NAME = Publisher
12871324
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
12881325
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
12891326
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1290-
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1291-
# Windows.
1327+
# (see:
1328+
# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
12921329
#
12931330
# The HTML Help Workshop contains a compiler that can convert all HTML output
12941331
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
@@ -1318,7 +1355,7 @@ CHM_FILE =
13181355
HHC_LOCATION =
13191356

13201357
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1321-
# (YES) or that it should be included in the master .chm file (NO).
1358+
# (YES) or that it should be included in the main .chm file (NO).
13221359
# The default value is: NO.
13231360
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
13241361

@@ -1363,33 +1400,34 @@ QCH_FILE =
13631400

13641401
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
13651402
# Project output. For more information please see Qt Help Project / Namespace
1366-
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1403+
# (see:
1404+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
13671405
# The default value is: org.doxygen.Project.
13681406
# This tag requires that the tag GENERATE_QHP is set to YES.
13691407

13701408
QHP_NAMESPACE = org.doxygen.Project
13711409

13721410
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
13731411
# Help Project output. For more information please see Qt Help Project / Virtual
1374-
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
1375-
# folders).
1412+
# Folders (see:
1413+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
13761414
# The default value is: doc.
13771415
# This tag requires that the tag GENERATE_QHP is set to YES.
13781416

13791417
QHP_VIRTUAL_FOLDER = doc
13801418

13811419
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
13821420
# filter to add. For more information please see Qt Help Project / Custom
1383-
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1384-
# filters).
1421+
# Filters (see:
1422+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
13851423
# This tag requires that the tag GENERATE_QHP is set to YES.
13861424

13871425
QHP_CUST_FILTER_NAME =
13881426

13891427
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
13901428
# custom filter to add. For more information please see Qt Help Project / Custom
1391-
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
1392-
# filters).
1429+
# Filters (see:
1430+
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
13931431
# This tag requires that the tag GENERATE_QHP is set to YES.
13941432

13951433
QHP_CUST_FILTER_ATTRS =
@@ -1401,9 +1439,9 @@ QHP_CUST_FILTER_ATTRS =
14011439

14021440
QHP_SECT_FILTER_ATTRS =
14031441

1404-
# The QHG_LOCATION tag can be used to specify the location of Qt's
1405-
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1406-
# generated .qhp file.
1442+
# The QHG_LOCATION tag can be used to specify the location (absolute path
1443+
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1444+
# run qhelpgenerator on the generated .qhp file.
14071445
# This tag requires that the tag GENERATE_QHP is set to YES.
14081446

14091447
QHG_LOCATION =
@@ -1484,8 +1522,8 @@ EXT_LINKS_IN_WINDOW = NO
14841522
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
14851523
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
14861524
# the HTML output. These images will generally look nicer at scaled resolutions.
1487-
# Possible values are: png The default and svg Looks nicer but requires the
1488-
# pdf2svg tool.
1525+
# Possible values are: png (the default) and svg (looks nicer but requires the
1526+
# pdf2svg or inkscape tool).
14891527
# The default value is: png.
14901528
# This tag requires that the tag GENERATE_HTML is set to YES.
14911529

@@ -1530,7 +1568,7 @@ USE_MATHJAX = NO
15301568

15311569
# When MathJax is enabled you can set the default output format to be used for
15321570
# the MathJax output. See the MathJax site (see:
1533-
# http://docs.mathjax.org/en/latest/output.html) for more details.
1571+
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
15341572
# Possible values are: HTML-CSS (which is slower, but has the best
15351573
# compatibility), NativeMML (i.e. MathML) and SVG.
15361574
# The default value is: HTML-CSS.
@@ -1560,7 +1598,8 @@ MATHJAX_EXTENSIONS =
15601598

15611599
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
15621600
# of code that will be used on startup of the MathJax code. See the MathJax site
1563-
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1601+
# (see:
1602+
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
15641603
# example see the documentation.
15651604
# This tag requires that the tag USE_MATHJAX is set to YES.
15661605

@@ -1607,7 +1646,8 @@ SERVER_BASED_SEARCH = NO
16071646
#
16081647
# Doxygen ships with an example indexer (doxyindexer) and search engine
16091648
# (doxysearch.cgi) which are based on the open source search engine library
1610-
# Xapian (see: https://xapian.org/).
1649+
# Xapian (see:
1650+
# https://xapian.org/).
16111651
#
16121652
# See the section "External Indexing and Searching" for details.
16131653
# The default value is: NO.
@@ -1620,8 +1660,9 @@ EXTERNAL_SEARCH = NO
16201660
#
16211661
# Doxygen ships with an example indexer (doxyindexer) and search engine
16221662
# (doxysearch.cgi) which are based on the open source search engine library
1623-
# Xapian (see: https://xapian.org/). See the section "External Indexing and
1624-
# Searching" for details.
1663+
# Xapian (see:
1664+
# https://xapian.org/). See the section "External Indexing and Searching" for
1665+
# details.
16251666
# This tag requires that the tag SEARCHENGINE is set to YES.
16261667

16271668
SEARCHENGINE_URL =
@@ -1785,9 +1826,11 @@ LATEX_EXTRA_FILES =
17851826

17861827
PDF_HYPERLINKS = YES
17871828

1788-
# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1789-
# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1790-
# higher quality PDF documentation.
1829+
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1830+
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1831+
# files. Set this option to YES, to get a higher quality PDF documentation.
1832+
#
1833+
# See also section LATEX_CMD_NAME for selecting the engine.
17911834
# The default value is: YES.
17921835
# This tag requires that the tag GENERATE_LATEX is set to YES.
17931836

@@ -2298,10 +2341,32 @@ UML_LOOK = NO
22982341
# but if the number exceeds 15, the total amount of fields shown is limited to
22992342
# 10.
23002343
# Minimum value: 0, maximum value: 100, default value: 10.
2301-
# This tag requires that the tag HAVE_DOT is set to YES.
2344+
# This tag requires that the tag UML_LOOK is set to YES.
23022345

23032346
UML_LIMIT_NUM_FIELDS = 10
23042347

2348+
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2349+
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2350+
# tag is set to YES, doxygen will add type and arguments for attributes and
2351+
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2352+
# will not generate fields with class member information in the UML graphs. The
2353+
# class diagrams will look similar to the default class diagrams but using UML
2354+
# notation for the relationships.
2355+
# Possible values are: NO, YES and NONE.
2356+
# The default value is: NO.
2357+
# This tag requires that the tag UML_LOOK is set to YES.
2358+
2359+
DOT_UML_DETAILS = NO
2360+
2361+
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2362+
# to display on a single line. If the actual line length exceeds this threshold
2363+
# significantly it will wrapped across multiple lines. Some heuristics are apply
2364+
# to avoid ugly line breaks.
2365+
# Minimum value: 0, maximum value: 1000, default value: 17.
2366+
# This tag requires that the tag HAVE_DOT is set to YES.
2367+
2368+
DOT_WRAP_THRESHOLD = 17
2369+
23052370
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
23062371
# collaboration graphs will show the relations between templates and their
23072372
# instances.
@@ -2491,9 +2556,11 @@ DOT_MULTI_TARGETS = NO
24912556

24922557
GENERATE_LEGEND = YES
24932558

2494-
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2559+
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
24952560
# files that are used to generate the various graphs.
2561+
#
2562+
# Note: This setting is not only used for dot files but also for msc and
2563+
# plantuml temporary files.
24962564
# The default value is: YES.
2497-
# This tag requires that the tag HAVE_DOT is set to YES.
24982565

24992566
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)