Skip to content

Commit da2e11c

Browse files
committed
DOXYGEN: Update for new version [ci skip]
1 parent 83cd334 commit da2e11c

File tree

4 files changed

+442
-258
lines changed

4 files changed

+442
-258
lines changed

packages/seacas/applications/zellij/Doxyfile

Lines changed: 111 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.9.5
1+
# Doxyfile 1.9.7
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -86,7 +86,7 @@ CREATE_SUBDIRS = NO
8686
# level increment doubles the number of directories, resulting in 4096
8787
# directories at level 8 which is the default and also the maximum value. The
8888
# sub-directories are organized in 2 levels, the first level always has a fixed
89-
# numer of 16 directories.
89+
# number of 16 directories.
9090
# Minimum value: 0, maximum value: 8, default value: 8.
9191
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
9292

@@ -363,6 +363,17 @@ MARKDOWN_SUPPORT = YES
363363

364364
TOC_INCLUDE_HEADINGS = 5
365365

366+
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
367+
# generate identifiers for the Markdown headings. Note: Every identifier is
368+
# unique.
369+
# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a
370+
# sequence number starting at 0. and GITHUB Use the lower case version of title
371+
# with any whitespace replaced by '-' and punctations characters removed..
372+
# The default value is: DOXYGEN.
373+
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
374+
375+
MARKDOWN_ID_STYLE = DOXYGEN
376+
366377
# When enabled doxygen tries to link words that correspond to documented
367378
# classes, or namespaces to their corresponding documentation. Such a link can
368379
# be prevented in individual cases by putting a % sign in front of the word or
@@ -487,6 +498,14 @@ LOOKUP_CACHE_SIZE = 0
487498

488499
NUM_PROC_THREADS = 1
489500

501+
# If the TIMESTAMP tag is set different from NO then each generated page will
502+
# contain the date or date and time when the page was generated. Setting this to
503+
# NO can help when comparing the output of multiple runs.
504+
# Possible values are: YES, NO, DATETIME and DATE.
505+
# The default value is: NO.
506+
507+
TIMESTAMP = NO
508+
490509
#---------------------------------------------------------------------------
491510
# Build related configuration options
492511
#---------------------------------------------------------------------------
@@ -568,7 +587,8 @@ HIDE_UNDOC_MEMBERS = NO
568587
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
569588
# undocumented classes that are normally visible in the class hierarchy. If set
570589
# to NO, these classes will be included in the various overviews. This option
571-
# has no effect if EXTRACT_ALL is enabled.
590+
# will also hide undocumented C++ concepts if enabled. This option has no effect
591+
# if EXTRACT_ALL is enabled.
572592
# The default value is: NO.
573593

574594
HIDE_UNDOC_CLASSES = NO
@@ -859,11 +879,26 @@ WARN_IF_INCOMPLETE_DOC = YES
859879

860880
WARN_NO_PARAMDOC = NO
861881

882+
# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
883+
# undocumented enumeration values. If set to NO, doxygen will accept
884+
# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
885+
# will automatically be disabled.
886+
# The default value is: NO.
887+
888+
WARN_IF_UNDOC_ENUM_VAL = NO
889+
862890
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
863891
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
864892
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
865893
# at the end of the doxygen process doxygen will return with a non-zero status.
866-
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
894+
# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
895+
# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
896+
# write the warning messages in between other messages but write them at the end
897+
# of a run, in case a WARN_LOGFILE is defined the warning messages will be
898+
# besides being in the defined file also be shown at the end of a run, unless
899+
# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
900+
# the behavior will remain as with the setting FAIL_ON_WARNINGS.
901+
# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
867902
# The default value is: NO.
868903

869904
WARN_AS_ERROR = NO
@@ -1031,9 +1066,6 @@ EXCLUDE_PATTERNS =
10311066
# output. The symbol name can be a fully qualified name, a word, or if the
10321067
# wildcard * is used, a substring. Examples: ANamespace, AClass,
10331068
# ANamespace::AClass, ANamespace::*Test
1034-
#
1035-
# Note that the wildcards are matched against the file with absolute path, so to
1036-
# exclude all test directories use the pattern */test/*
10371069

10381070
EXCLUDE_SYMBOLS =
10391071

@@ -1230,10 +1262,11 @@ VERBATIM_HEADERS = YES
12301262

12311263
ALPHABETICAL_INDEX = YES
12321264

1233-
# In case all classes in a project start with a common prefix, all classes will
1234-
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1235-
# can be used to specify a prefix (or a list of prefixes) that should be ignored
1236-
# while generating the index headers.
1265+
# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1266+
# that should be ignored while generating the index headers. The IGNORE_PREFIX
1267+
# tag works for classes, function and member names. The entity will be placed in
1268+
# the alphabetical list under the first letter of the entity name that remains
1269+
# after removing the prefix.
12371270
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
12381271

12391272
IGNORE_PREFIX =
@@ -1312,7 +1345,12 @@ HTML_STYLESHEET =
13121345
# Doxygen will copy the style sheet files to the output directory.
13131346
# Note: The order of the extra style sheet files is of importance (e.g. the last
13141347
# style sheet in the list overrules the setting of the previous ones in the
1315-
# list). For an example see the documentation.
1348+
# list).
1349+
# Note: Since the styling of scrollbars can currently not be overruled in
1350+
# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1351+
# one or more extra stylesheets have been specified. So if scrollbar
1352+
# customization is desired it has to be added explicitly. For an example see the
1353+
# documentation.
13161354
# This tag requires that the tag GENERATE_HTML is set to YES.
13171355

13181356
HTML_EXTRA_STYLESHEET =
@@ -1328,17 +1366,13 @@ HTML_EXTRA_STYLESHEET =
13281366
HTML_EXTRA_FILES =
13291367

13301368
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1331-
# should be rendered with a dark or light theme. Default setting AUTO_LIGHT
1332-
# enables light output unless the user preference is dark output. Other options
1333-
# are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to
1334-
# default to dark mode unless the user prefers light mode, and TOGGLE to let the
1335-
# user toggle between dark and light mode via a button.
1336-
# Possible values are: LIGHT Always generate light output., DARK Always generate
1337-
# dark output., AUTO_LIGHT Automatically set the mode according to the user
1338-
# preference, use light mode if no preference is set (the default)., AUTO_DARK
1339-
# Automatically set the mode according to the user preference, use dark mode if
1340-
# no preference is set. and TOGGLE Allow to user to switch between light and
1341-
# dark mode via a button..
1369+
# should be rendered with a dark or light theme.
1370+
# Possible values are: LIGHT always generate light mode output, DARK always
1371+
# generate dark mode output, AUTO_LIGHT automatically set the mode according to
1372+
# the user preference, use light mode if no preference is set (the default),
1373+
# AUTO_DARK automatically set the mode according to the user preference, use
1374+
# dark mode if no preference is set and TOGGLE allow to user to switch between
1375+
# light and dark mode via a button.
13421376
# The default value is: AUTO_LIGHT.
13431377
# This tag requires that the tag GENERATE_HTML is set to YES.
13441378

@@ -1374,15 +1408,6 @@ HTML_COLORSTYLE_SAT = 100
13741408

13751409
HTML_COLORSTYLE_GAMMA = 80
13761410

1377-
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1378-
# page will contain the date and time when the page was generated. Setting this
1379-
# to YES can help to show when doxygen was last run and thus if the
1380-
# documentation is up to date.
1381-
# The default value is: NO.
1382-
# This tag requires that the tag GENERATE_HTML is set to YES.
1383-
1384-
HTML_TIMESTAMP = NO
1385-
13861411
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
13871412
# documentation will contain a main index with vertical navigation menus that
13881413
# are dynamically created via JavaScript. If disabled, the navigation index will
@@ -1532,6 +1557,16 @@ BINARY_TOC = NO
15321557

15331558
TOC_EXPAND = NO
15341559

1560+
# The SITEMAP_URL tag is used to specify the full URL of the place where the
1561+
# generated documentation will be placed on the server by the user during the
1562+
# deployment of the documentation. The generated sitemap is called sitemap.xml
1563+
# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1564+
# is specified no sitemap is generated. For information about the sitemap
1565+
# protocol see https://www.sitemaps.org
1566+
# This tag requires that the tag GENERATE_HTML is set to YES.
1567+
1568+
SITEMAP_URL =
1569+
15351570
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
15361571
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
15371572
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
@@ -2020,9 +2055,16 @@ PDF_HYPERLINKS = YES
20202055

20212056
USE_PDFLATEX = YES
20222057

2023-
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
2024-
# command to the generated LaTeX files. This will instruct LaTeX to keep running
2025-
# if errors occur, instead of asking the user for help.
2058+
# The LATEX_BATCHMODE tag ignals the behavior of LaTeX in case of an error.
2059+
# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2060+
# mode nothing is printed on the terminal, errors are scrolled as if <return> is
2061+
# hit at every error; missing files that TeX tries to input or request from
2062+
# keyboard input (\read on a not open input stream) cause the job to abort,
2063+
# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2064+
# but there is no possibility of user interaction just like in batch mode,
2065+
# SCROLL In scroll mode, TeX will stop only for missing files to input or if
2066+
# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2067+
# each error, asking for user intervention.
20262068
# The default value is: NO.
20272069
# This tag requires that the tag GENERATE_LATEX is set to YES.
20282070

@@ -2043,14 +2085,6 @@ LATEX_HIDE_INDICES = NO
20432085

20442086
LATEX_BIB_STYLE = plain
20452087

2046-
# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
2047-
# page will contain the date and time when the page was generated. Setting this
2048-
# to NO can help when comparing the output of multiple runs.
2049-
# The default value is: NO.
2050-
# This tag requires that the tag GENERATE_LATEX is set to YES.
2051-
2052-
LATEX_TIMESTAMP = NO
2053-
20542088
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
20552089
# path from which the emoji images will be read. If a relative path is entered,
20562090
# it will be relative to the LATEX_OUTPUT directory. If left blank the
@@ -2216,7 +2250,7 @@ DOCBOOK_OUTPUT = docbook
22162250
#---------------------------------------------------------------------------
22172251

22182252
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2219-
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2253+
# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
22202254
# the structure of the code including all documentation. Note that this feature
22212255
# is still experimental and incomplete at the moment.
22222256
# The default value is: NO.
@@ -2387,16 +2421,9 @@ EXTERNAL_GROUPS = YES
23872421
EXTERNAL_PAGES = YES
23882422

23892423
#---------------------------------------------------------------------------
2390-
# Configuration options related to the dot tool
2424+
# Configuration options related to diagram generator tools
23912425
#---------------------------------------------------------------------------
23922426

2393-
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2394-
# then run dia to produce the diagram and insert it in the documentation. The
2395-
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2396-
# If left empty dia is assumed to be found in the default search path.
2397-
2398-
DIA_PATH =
2399-
24002427
# If set to YES the inheritance and collaboration graphs will hide inheritance
24012428
# and usage relations if the target is undocumented or is not a class.
24022429
# The default value is: YES.
@@ -2405,7 +2432,7 @@ HIDE_UNDOC_RELATIONS = YES
24052432

24062433
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
24072434
# available from the path. This tool is part of Graphviz (see:
2408-
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2435+
# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
24092436
# Bell Labs. The other options in this section have no effect if this option is
24102437
# set to NO
24112438
# The default value is: NO.
@@ -2458,13 +2485,15 @@ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
24582485

24592486
DOT_FONTPATH =
24602487

2461-
# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
2462-
# graph for each documented class showing the direct and indirect inheritance
2463-
# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
2464-
# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
2465-
# to TEXT the direct and indirect inheritance relations will be shown as texts /
2466-
# links.
2467-
# Possible values are: NO, YES, TEXT and GRAPH.
2488+
# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2489+
# generate a graph for each documented class showing the direct and indirect
2490+
# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2491+
# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2492+
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2493+
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2494+
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2495+
# relations will be shown as texts / links.
2496+
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
24682497
# The default value is: YES.
24692498

24702499
CLASS_GRAPH = YES
@@ -2605,7 +2634,7 @@ DIR_GRAPH_MAX_DEPTH = 1
26052634
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
26062635
# generated by dot. For an explanation of the image formats see the section
26072636
# output formats in the documentation of the dot tool (Graphviz (see:
2608-
# http://www.graphviz.org/)).
2637+
# https://www.graphviz.org/)).
26092638
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
26102639
# to make the SVG files visible in IE 9+ (other browsers do not have this
26112640
# requirement).
@@ -2642,11 +2671,12 @@ DOT_PATH =
26422671

26432672
DOTFILE_DIRS =
26442673

2645-
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2646-
# contain msc files that are included in the documentation (see the \mscfile
2647-
# command).
2674+
# You can include diagrams made with dia in doxygen documentation. Doxygen will
2675+
# then run dia to produce the diagram and insert it in the documentation. The
2676+
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2677+
# If left empty dia is assumed to be found in the default search path.
26482678

2649-
MSCFILE_DIRS =
2679+
DIA_PATH =
26502680

26512681
# The DIAFILE_DIRS tag can be used to specify one or more directories that
26522682
# contain dia files that are included in the documentation (see the \diafile
@@ -2723,3 +2753,19 @@ GENERATE_LEGEND = YES
27232753
# The default value is: YES.
27242754

27252755
DOT_CLEANUP = YES
2756+
2757+
# You can define message sequence charts within doxygen comments using the \msc
2758+
# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2759+
# use a built-in version of mscgen tool to produce the charts. Alternatively,
2760+
# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2761+
# specifying prog as the value, doxygen will call the tool as prog -T
2762+
# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2763+
# output file formats "png", "eps", "svg", and "ismap".
2764+
2765+
MSCGEN_TOOL =
2766+
2767+
# The MSCFILE_DIRS tag can be used to specify one or more directories that
2768+
# contain msc files that are included in the documentation (see the \mscfile
2769+
# command).
2770+
2771+
MSCFILE_DIRS =

0 commit comments

Comments
 (0)