1
- # Doxyfile 1.8.17
1
+ # Doxyfile 1.8.20
2
2
3
3
# This file describes the settings to be used by the documentation system
4
4
# doxygen (www.doxygen.org) for a project.
@@ -186,7 +186,7 @@ STRIP_FROM_INC_PATH =
186
186
# support long names like on DOS, Mac, or CD-ROM.
187
187
# The default value is: NO.
188
188
189
- SHORT_NAMES = NO
189
+ SHORT_NAMES = YES
190
190
191
191
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192
192
# first line (until the first dot) of a Javadoc-style comment as the brief
@@ -227,6 +227,14 @@ QT_AUTOBRIEF = NO
227
227
228
228
MULTILINE_CPP_IS_BRIEF = NO
229
229
230
+ # By default Python docstrings are displayed as preformatted text and doxygen's
231
+ # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
232
+ # doxygen's special commands can be used and the contents of the docstring
233
+ # documentation blocks is shown as doxygen documentation.
234
+ # The default value is: YES.
235
+
236
+ PYTHON_DOCSTRING = YES
237
+
230
238
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
231
239
# documentation from any documented member that it re-implements.
232
240
# The default value is: YES.
@@ -263,12 +271,6 @@ TAB_SIZE = 4
263
271
264
272
ALIASES =
265
273
266
- # This tag can be used to specify a number of word-keyword mappings (TCL only).
267
- # A mapping has the form "name=value". For example adding "class=itcl::class"
268
- # will allow you to use the command class in the itcl::class meaning.
269
-
270
- TCL_SUBST =
271
-
272
274
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
273
275
# only. Doxygen will then generate output that is more tailored for C. For
274
276
# instance, some of the names that are used will be different. The list of all
@@ -310,13 +312,13 @@ OPTIMIZE_OUTPUT_SLICE = NO
310
312
# extension. Doxygen has a built-in mapping, but you can override or extend it
311
313
# using this tag. The format is ext=language, where ext is a file extension, and
312
314
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
313
- # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
315
+ # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
314
316
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
315
317
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
316
318
# tries to guess whether the code is fixed or free formatted code, this is the
317
- # default for Fortran type files), VHDL, tcl . For instance to make doxygen treat
318
- # .inc files as Fortran files (default is PHP), and .f files as C (default is
319
- # Fortran), use: inc=Fortran f=C.
319
+ # default for Fortran type files). For instance to make doxygen treat .inc files
320
+ # as Fortran files (default is PHP), and .f files as C (default is Fortran),
321
+ # use: inc=Fortran f=C.
320
322
#
321
323
# Note: For files without extension you can use no_extension as a placeholder.
322
324
#
@@ -455,6 +457,19 @@ TYPEDEF_HIDES_STRUCT = NO
455
457
456
458
LOOKUP_CACHE_SIZE = 0
457
459
460
+ # The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
461
+ # during processing. When set to 0 doxygen will based this on the number of
462
+ # cores available in the system. You can set it explicitly to a value larger
463
+ # than 0 to get more control over the balance between CPU load and processing
464
+ # speed. At this moment only the input processing can be done using multiple
465
+ # threads. Since this is still an experimental feature the default is set to 1,
466
+ # which efficively disables parallel processing. Please report any issues you
467
+ # encounter. Generating dot graphs in parallel is controlled by the
468
+ # DOT_NUM_THREADS setting.
469
+ # Minimum value: 0, maximum value: 32, default value: 1.
470
+
471
+ NUM_PROC_THREADS = 1
472
+
458
473
# ---------------------------------------------------------------------------
459
474
# Build related configuration options
460
475
# ---------------------------------------------------------------------------
@@ -559,7 +574,7 @@ INTERNAL_DOCS = YES
559
574
# names in lower-case letters. If set to YES, upper-case letters are also
560
575
# allowed. This is useful if you have classes or files whose names only differ
561
576
# in case and if your file system supports case sensitive file names. Windows
562
- # (including Cygwin) ands Mac users are advised to set this option to NO.
577
+ # (including Cygwin) and Mac users are advised to set this option to NO.
563
578
# The default value is: system dependent.
564
579
565
580
CASE_SENSE_NAMES = YES
@@ -829,15 +844,14 @@ WARN_LOGFILE =
829
844
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
830
845
# Note: If this tag is empty the current directory is searched.
831
846
832
- INPUT = $(HIP_PATH)/docs/doxygen-input/mainpage.txt \
833
- $(HIP_PATH)/README.md \
834
- $(HIP_PATH)/CONTRIBUTING.md \
835
- $(HIP_PATH)/docs/doxygen-input/sync.txt \
836
- $(HIP_PATH)/INSTALL.md \
837
- $(HIP_PATH)/docs/markdown \
838
- $(HIP_PATH)/include/hip \
839
- $(HIP_PATH)/include/hip/amd_detail/ \
840
- $(HIP_PATH)/src/
847
+ INPUT = mainpage.txt \
848
+ ../../README.md \
849
+ ../../CONTRIBUTING.md \
850
+ sync.txt \
851
+ ../../INSTALL.md \
852
+ ../../docs/markdown \
853
+ ../../include/hip \
854
+ ../../../hipamd/include/hip/amd_detail/
841
855
842
856
# This tag can be used to specify the character encoding of the source files
843
857
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -861,7 +875,7 @@ INPUT_ENCODING = UTF-8
861
875
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
862
876
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
863
877
# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
864
- # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f , *.for , *.tcl , *.vhd,
878
+ # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18 , *.f , *.for , *.vhd,
865
879
# *.vhdl, *.ucf, *.qsf and *.ice.
866
880
867
881
FILE_PATTERNS = *.c \
@@ -873,7 +887,7 @@ FILE_PATTERNS = *.c \
873
887
*.md \
874
888
*.dox \
875
889
*.doc \
876
- *.txt \
890
+ *.txt
877
891
878
892
# The RECURSIVE tag can be used to specify whether or not subdirectories should
879
893
# be searched for input files as well.
@@ -941,7 +955,7 @@ EXAMPLE_RECURSIVE = NO
941
955
# that contain images that are to be included in the documentation (see the
942
956
# \image command).
943
957
944
- IMAGE_PATH = $(HIP_PATH)/docs/doxygen-input/ images
958
+ IMAGE_PATH = images
945
959
946
960
# The INPUT_FILTER tag can be used to specify a program that doxygen should
947
961
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1105,10 +1119,13 @@ CLANG_ASSISTED_PARSING = NO
1105
1119
CLANG_OPTIONS =
1106
1120
1107
1121
# If clang assisted parsing is enabled you can provide the clang parser with the
1108
- # path to the compilation database (see:
1109
- # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1110
- # were built. This is equivalent to specifying the "-p" option to a clang tool,
1111
- # such as clang-check. These options will then be passed to the parser.
1122
+ # path to the directory containing a file called compile_commands.json. This
1123
+ # file is the compilation database (see:
1124
+ # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1125
+ # options used when the source files were built. This is equivalent to
1126
+ # specifying the "-p" option to a clang tool, such as clang-check. These options
1127
+ # will then be passed to the parser. Any options specified with CLANG_OPTIONS
1128
+ # will be added as well.
1112
1129
# Note: The availability of this option depends on whether or not doxygen was
1113
1130
# generated with the -Duse_libclang=ON option for CMake.
1114
1131
@@ -1378,7 +1395,7 @@ CHM_FILE =
1378
1395
HHC_LOCATION =
1379
1396
1380
1397
# The GENERATE_CHI flag controls if a separate .chi index file is generated
1381
- # (YES) or that it should be included in the master .chm file (NO).
1398
+ # (YES) or that it should be included in the main .chm file (NO).
1382
1399
# The default value is: NO.
1383
1400
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1384
1401
@@ -1540,6 +1557,17 @@ TREEVIEW_WIDTH = 250
1540
1557
1541
1558
EXT_LINKS_IN_WINDOW = NO
1542
1559
1560
+ # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1561
+ # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1562
+ # https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1563
+ # the HTML output. These images will generally look nicer at scaled resolutions.
1564
+ # Possible values are: png (the default) and svg (looks nicer but requires the
1565
+ # pdf2svg or inkscape tool).
1566
+ # The default value is: png.
1567
+ # This tag requires that the tag GENERATE_HTML is set to YES.
1568
+
1569
+ HTML_FORMULA_FORMAT = png
1570
+
1543
1571
# Use this tag to change the font size of LaTeX formulas included as images in
1544
1572
# the HTML documentation. When you change the font size after a successful
1545
1573
# doxygen run you need to manually remove any form_*.png images from the HTML
@@ -1595,7 +1623,7 @@ MATHJAX_FORMAT = HTML-CSS
1595
1623
# Content Delivery Network so you can quickly see the result without installing
1596
1624
# MathJax. However, it is strongly recommended to install a local copy of
1597
1625
# MathJax from https://www.mathjax.org before deployment.
1598
- # The default value is: https://cdnjs.cloudflare.com/ajax/libs/ mathjax/2.7.5/ .
1626
+ # The default value is: https://cdn.jsdelivr.net/npm/ mathjax@2 .
1599
1627
# This tag requires that the tag USE_MATHJAX is set to YES.
1600
1628
1601
1629
MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/
@@ -1834,9 +1862,11 @@ LATEX_EXTRA_FILES =
1834
1862
1835
1863
PDF_HYPERLINKS = YES
1836
1864
1837
- # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1838
- # the PDF file directly from the LaTeX files. Set this option to YES, to get a
1839
- # higher quality PDF documentation.
1865
+ # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1866
+ # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1867
+ # files. Set this option to YES, to get a higher quality PDF documentation.
1868
+ #
1869
+ # See also section LATEX_CMD_NAME for selecting the engine.
1840
1870
# The default value is: YES.
1841
1871
# This tag requires that the tag GENERATE_LATEX is set to YES.
1842
1872
@@ -2075,6 +2105,10 @@ DOCBOOK_PROGRAMLISTING = NO
2075
2105
2076
2106
GENERATE_AUTOGEN_DEF = NO
2077
2107
2108
+ # ---------------------------------------------------------------------------
2109
+ # Configuration options related to Sqlite3 output
2110
+ # ---------------------------------------------------------------------------
2111
+
2078
2112
# ---------------------------------------------------------------------------
2079
2113
# Configuration options related to the Perl module output
2080
2114
# ---------------------------------------------------------------------------
@@ -2170,7 +2204,8 @@ INCLUDE_FILE_PATTERNS =
2170
2204
# recursively expanded use the := operator instead of the = operator.
2171
2205
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2172
2206
2173
- PREDEFINED = __HIP_PLATFORM_AMD__
2207
+ PREDEFINED = __HIP_PLATFORM_AMD__ \
2208
+ __HIP__
2174
2209
2175
2210
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2176
2211
# tag can be used to specify a list of macro names that should be expanded. The
@@ -2268,9 +2303,9 @@ HIDE_UNDOC_RELATIONS = YES
2268
2303
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2269
2304
# Bell Labs. The other options in this section have no effect if this option is
2270
2305
# set to NO
2271
- # The default value is: YES .
2306
+ # The default value is: NO .
2272
2307
2273
- HAVE_DOT = YES
2308
+ HAVE_DOT = NO
2274
2309
2275
2310
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2276
2311
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2424,9 +2459,7 @@ DIRECTORY_GRAPH = YES
2424
2459
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2425
2460
# to make the SVG files visible in IE 9+ (other browsers do not have this
2426
2461
# requirement).
2427
- # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2428
- # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2429
- # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2462
+ # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2430
2463
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2431
2464
# png:gdiplus:gdiplus.
2432
2465
# The default value is: png.
0 commit comments