Skip to content

Commit 2f65a5f

Browse files
Update doxygen.conf.in file from 1.9.7 to 1.10.0
Done with 'doxygen -u doxygen.conf.in'
1 parent a217c5c commit 2f65a5f

File tree

1 file changed

+105
-26
lines changed

1 file changed

+105
-26
lines changed

doc/doxygen.conf.in

Lines changed: 105 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.9.7
1+
# Doxyfile 1.10.0
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -63,6 +63,12 @@ PROJECT_BRIEF =
6363

6464
PROJECT_LOGO =
6565

66+
# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67+
# when the HTML document is shown. Doxygen will copy the logo to the output
68+
# directory.
69+
70+
PROJECT_ICON =
71+
6672
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
6773
# into which the generated documentation will be written. If a relative path is
6874
# entered, it will be relative to the location where doxygen was started. If
@@ -356,9 +362,9 @@ TOC_INCLUDE_HEADINGS = 5
356362
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
357363
# generate identifiers for the Markdown headings. Note: Every identifier is
358364
# unique.
359-
# Possible values are: DOXYGEN Use a fixed 'autotoc_md' string followed by a
360-
# sequence number starting at 0. and GITHUB Use the lower case version of title
361-
# with any whitespace replaced by '-' and punctuation characters removed..
365+
# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
366+
# sequence number starting at 0 and GITHUB use the lower case version of title
367+
# with any whitespace replaced by '-' and punctuation characters removed.
362368
# The default value is: DOXYGEN.
363369
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
364370

@@ -933,7 +939,8 @@ WARN_LOGFILE =
933939
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
934940
# Note: If this tag is empty the current directory is searched.
935941

936-
INPUT = ../src pcsclite.h
942+
INPUT = ../src \
943+
pcsclite.h
937944

938945
# This tag can be used to specify the character encoding of the source files
939946
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -966,12 +973,12 @@ INPUT_FILE_ENCODING =
966973
# Note the list of default checked file patterns might differ from the list of
967974
# default file extension mappings.
968975
#
969-
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
970-
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
971-
# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
972-
# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
973-
# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
974-
# *.vhdl, *.ucf, *.qsf and *.ice.
976+
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
977+
# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
978+
# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,
979+
# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
980+
# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
981+
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
975982

976983
FILE_PATTERNS = *.c \
977984
*.h
@@ -1125,7 +1132,8 @@ FORTRAN_COMMENT_AFTER = 72
11251132
SOURCE_BROWSER = YES
11261133

11271134
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1128-
# classes and enums directly into the documentation.
1135+
# multi-line macros, enums or list initialized variables directly into the
1136+
# documentation.
11291137
# The default value is: NO.
11301138

11311139
INLINE_SOURCES = NO
@@ -1373,6 +1381,33 @@ HTML_DYNAMIC_MENUS = YES
13731381

13741382
HTML_DYNAMIC_SECTIONS = NO
13751383

1384+
# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1385+
# dynamically folded and expanded in the generated HTML source code.
1386+
# The default value is: YES.
1387+
# This tag requires that the tag GENERATE_HTML is set to YES.
1388+
1389+
HTML_CODE_FOLDING = YES
1390+
1391+
# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in
1392+
# the top right corner of code and text fragments that allows the user to copy
1393+
# its content to the clipboard. Note this only works if supported by the browser
1394+
# and the web page is served via a secure context (see:
1395+
# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1396+
# protocol.
1397+
# The default value is: YES.
1398+
# This tag requires that the tag GENERATE_HTML is set to YES.
1399+
1400+
HTML_COPY_CLIPBOARD = YES
1401+
1402+
# Doxygen stores a couple of settings persistently in the browser (via e.g.
1403+
# cookies). By default these settings apply to all HTML pages generated by
1404+
# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1405+
# the settings under a project specific key, such that the user preferences will
1406+
# be stored separately.
1407+
# This tag requires that the tag GENERATE_HTML is set to YES.
1408+
1409+
HTML_PROJECT_COOKIE =
1410+
13761411
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
13771412
# shown in the various tree structured indices initially; the user can expand
13781413
# and collapse entries dynamically later on. Doxygen will expand the tree to
@@ -2001,7 +2036,7 @@ PDF_HYPERLINKS = NO
20012036

20022037
USE_PDFLATEX = NO
20032038

2004-
# The LATEX_BATCHMODE tag ignals the behavior of LaTeX in case of an error.
2039+
# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
20052040
# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
20062041
# mode nothing is printed on the terminal, errors are scrolled as if <return> is
20072042
# hit at every error; missing files that TeX tries to input or request from
@@ -2203,6 +2238,32 @@ DOCBOOK_OUTPUT = docbook
22032238

22042239
GENERATE_AUTOGEN_DEF = NO
22052240

2241+
#---------------------------------------------------------------------------
2242+
# Configuration options related to Sqlite3 output
2243+
#---------------------------------------------------------------------------
2244+
2245+
# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2246+
# database with symbols found by doxygen stored in tables.
2247+
# The default value is: NO.
2248+
2249+
GENERATE_SQLITE3 = NO
2250+
2251+
# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2252+
# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2253+
# in front of it.
2254+
# The default directory is: sqlite3.
2255+
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2256+
2257+
SQLITE3_OUTPUT = sqlite3
2258+
2259+
# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2260+
# database file will be recreated with each doxygen run. If set to NO, doxygen
2261+
# will warn if a database file is already found and not modify it.
2262+
# The default value is: YES.
2263+
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2264+
2265+
SQLITE3_RECREATE_DB = YES
2266+
22062267
#---------------------------------------------------------------------------
22072268
# Configuration options related to the Perl module output
22082269
#---------------------------------------------------------------------------
@@ -2345,15 +2406,15 @@ TAGFILES =
23452406

23462407
GENERATE_TAGFILE =
23472408

2348-
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2349-
# the class index. If set to NO, only the inherited external classes will be
2350-
# listed.
2409+
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2410+
# will be listed in the class and namespace index. If set to NO, only the
2411+
# inherited external classes will be listed.
23512412
# The default value is: NO.
23522413

23532414
ALLEXTERNALS = NO
23542415

23552416
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2356-
# in the modules index. If set to NO, only the current project's groups will be
2417+
# in the topic index. If set to NO, only the current project's groups will be
23572418
# listed.
23582419
# The default value is: YES.
23592420

@@ -2438,7 +2499,11 @@ DOT_FONTPATH =
24382499
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
24392500
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
24402501
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2441-
# relations will be shown as texts / links.
2502+
# relations will be shown as texts / links. Explicit enabling an inheritance
2503+
# graph or choosing a different representation for an inheritance graph of a
2504+
# specific class, can be accomplished by means of the command \inheritancegraph.
2505+
# Disabling an inheritance graph can be accomplished by means of the command
2506+
# \hideinheritancegraph.
24422507
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
24432508
# The default value is: YES.
24442509

@@ -2447,15 +2512,21 @@ CLASS_GRAPH = YES
24472512
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
24482513
# graph for each documented class showing the direct and indirect implementation
24492514
# dependencies (inheritance, containment, and class references variables) of the
2450-
# class with other documented classes.
2515+
# class with other documented classes. Explicit enabling a collaboration graph,
2516+
# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2517+
# command \collaborationgraph. Disabling a collaboration graph can be
2518+
# accomplished by means of the command \hidecollaborationgraph.
24512519
# The default value is: YES.
24522520
# This tag requires that the tag HAVE_DOT is set to YES.
24532521

24542522
COLLABORATION_GRAPH = YES
24552523

24562524
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2457-
# groups, showing the direct groups dependencies. See also the chapter Grouping
2458-
# in the manual.
2525+
# groups, showing the direct groups dependencies. Explicit enabling a group
2526+
# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2527+
# of the command \groupgraph. Disabling a directory graph can be accomplished by
2528+
# means of the command \hidegroupgraph. See also the chapter Grouping in the
2529+
# manual.
24592530
# The default value is: YES.
24602531
# This tag requires that the tag HAVE_DOT is set to YES.
24612532

@@ -2497,8 +2568,8 @@ DOT_UML_DETAILS = NO
24972568

24982569
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
24992570
# to display on a single line. If the actual line length exceeds this threshold
2500-
# significantly it will wrapped across multiple lines. Some heuristics are apply
2501-
# to avoid ugly line breaks.
2571+
# significantly it will be wrapped across multiple lines. Some heuristics are
2572+
# applied to avoid ugly line breaks.
25022573
# Minimum value: 0, maximum value: 1000, default value: 17.
25032574
# This tag requires that the tag HAVE_DOT is set to YES.
25042575

@@ -2515,7 +2586,9 @@ TEMPLATE_RELATIONS = NO
25152586
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
25162587
# YES then doxygen will generate a graph for each documented file showing the
25172588
# direct and indirect include dependencies of the file with other documented
2518-
# files.
2589+
# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2590+
# can be accomplished by means of the command \includegraph. Disabling an
2591+
# include graph can be accomplished by means of the command \hideincludegraph.
25192592
# The default value is: YES.
25202593
# This tag requires that the tag HAVE_DOT is set to YES.
25212594

@@ -2524,7 +2597,10 @@ INCLUDE_GRAPH = YES
25242597
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
25252598
# set to YES then doxygen will generate a graph for each documented file showing
25262599
# the direct and indirect include dependencies of the file with other documented
2527-
# files.
2600+
# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2601+
# to NO, can be accomplished by means of the command \includedbygraph. Disabling
2602+
# an included by graph can be accomplished by means of the command
2603+
# \hideincludedbygraph.
25282604
# The default value is: YES.
25292605
# This tag requires that the tag HAVE_DOT is set to YES.
25302606

@@ -2564,7 +2640,10 @@ GRAPHICAL_HIERARCHY = YES
25642640
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
25652641
# dependencies a directory has on other directories in a graphical way. The
25662642
# dependency relations are determined by the #include relations between the
2567-
# files in the directories.
2643+
# files in the directories. Explicit enabling a directory graph, when
2644+
# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2645+
# \directorygraph. Disabling a directory graph can be accomplished by means of
2646+
# the command \hidedirectorygraph.
25682647
# The default value is: YES.
25692648
# This tag requires that the tag HAVE_DOT is set to YES.
25702649

0 commit comments

Comments
 (0)