Skip to content

Commit cbe8883

Browse files
committed
docs
1 parent 259b038 commit cbe8883

1,617 files changed

Lines changed: 215686 additions & 74 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Doxyfile

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.15.0
1+
# Doxyfile 1.16.1
22

33
# This file describes the settings to be used by the documentation system
44
# Doxygen (www.doxygen.org) for a project.
@@ -104,7 +104,7 @@ CREATE_SUBDIRS_LEVEL = 8
104104
# U+3044.
105105
# The default value is: NO.
106106

107-
ALLOW_UNICODE_NAMES = NO
107+
ALLOW_UNICODE_NAMES = YES
108108

109109
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
110110
# documentation generated by Doxygen is written. Doxygen will use this
@@ -406,8 +406,8 @@ AUTOLINK_SUPPORT = YES
406406

407407
# This tag specifies a list of words that, when matching the start of a word in
408408
# the documentation, will suppress auto links generation, if it is enabled via
409-
# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \#
410-
# or the \link or commands.
409+
# AUTOLINK_SUPPORT. This list does not affect links explicitly created using #
410+
# or the \link or \ref commands.
411411
# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
412412

413413
AUTOLINK_IGNORE_WORDS =
@@ -452,7 +452,7 @@ IDL_PROPERTY_SUPPORT = YES
452452
# all members of a group must be documented explicitly.
453453
# The default value is: NO.
454454

455-
DISTRIBUTE_GROUP_DOC = NO
455+
DISTRIBUTE_GROUP_DOC = YES
456456

457457
# If one adds a struct or class to a group and this option is enabled, then also
458458
# any nested class or struct is added to the same group. By default this option
@@ -526,7 +526,7 @@ LOOKUP_CACHE_SIZE = 0
526526
# DOT_NUM_THREADS setting.
527527
# Minimum value: 0, maximum value: 512, default value: 1.
528528

529-
NUM_PROC_THREADS = 1
529+
NUM_PROC_THREADS = 0
530530

531531
# If the TIMESTAMP tag is set different from NO then each generated page will
532532
# contain the date or date and time when the page was generated. Setting this to
@@ -554,13 +554,13 @@ EXTRACT_ALL = YES
554554
# be included in the documentation.
555555
# The default value is: NO.
556556

557-
EXTRACT_PRIVATE = NO
557+
EXTRACT_PRIVATE = YES
558558

559559
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
560560
# methods of a class will be included in the documentation.
561561
# The default value is: NO.
562562

563-
EXTRACT_PRIV_VIRTUAL = NO
563+
EXTRACT_PRIV_VIRTUAL = YES
564564

565565
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
566566
# scope will be included in the documentation.
@@ -572,15 +572,15 @@ EXTRACT_PACKAGE = NO
572572
# included in the documentation.
573573
# The default value is: NO.
574574

575-
EXTRACT_STATIC = NO
575+
EXTRACT_STATIC = YES
576576

577577
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
578578
# locally in source files will be included in the documentation. If set to NO,
579579
# only classes defined in header files are included. Does not have any effect
580580
# for Java sources.
581581
# The default value is: YES.
582582

583-
EXTRACT_LOCAL_CLASSES = YES
583+
EXTRACT_LOCAL_CLASSES = NO
584584

585585
# This flag is only useful for Objective-C code. If set to YES, local methods,
586586
# which are defined in the implementation section but not in the interface are
@@ -629,7 +629,7 @@ HIDE_UNDOC_CLASSES = NO
629629
# option has no effect if EXTRACT_ALL is enabled.
630630
# The default value is: YES.
631631

632-
HIDE_UNDOC_NAMESPACES = YES
632+
HIDE_UNDOC_NAMESPACES = NO
633633

634634
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
635635
# declarations. If set to NO, these declarations will be included in the
@@ -746,7 +746,7 @@ SORT_MEMBERS_CTORS_1ST = NO
746746
# appear in their defined order.
747747
# The default value is: NO.
748748

749-
SORT_GROUP_NAMES = NO
749+
SORT_GROUP_NAMES = YES
750750

751751
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
752752
# fully-qualified names, including namespaces. If set to NO, the class list will
@@ -793,6 +793,27 @@ GENERATE_BUGLIST = YES
793793

794794
GENERATE_DEPRECATEDLIST= YES
795795

796+
# The GENERATE_REQUIREMENTS tag can be used to enable (YES) or disable (NO) the
797+
# requirements page. When enabled, this page is automatically created when at
798+
# least one comment block with a \requirement command appears in the input.
799+
# The default value is: YES.
800+
801+
GENERATE_REQUIREMENTS = YES
802+
803+
# The REQ_TRACEABILITY_INFO tag controls if traceability information is shown on
804+
# the requirements page (only relevant when using \requirement comment blocks).
805+
# The setting NO will disable the traceablility information altogether. The
806+
# setting UNSATISFIED_ONLY will show a list of requirements that are missing a
807+
# satisfies relation (through the command: \satisfies). Similarly the setting
808+
# UNVERIFIED_ONLY will show a list of requirements that are missing a verifies
809+
# relation (through the command: \verifies). Setting the tag to YES (the
810+
# default) will show both lists if applicable.
811+
# Possible values are: YES, NO, UNSATISFIED_ONLY and UNVERIFIED_ONLY.
812+
# The default value is: YES.
813+
# This tag requires that the tag GENERATE_REQUIREMENTS is set to YES.
814+
815+
REQ_TRACEABILITY_INFO = YES
816+
796817
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
797818
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
798819
# ... \endcond blocks.
@@ -815,21 +836,21 @@ MAX_INITIALIZER_LINES = 30
815836
# list will mention the files that were used to generate the documentation.
816837
# The default value is: YES.
817838

818-
SHOW_USED_FILES = YES
839+
SHOW_USED_FILES = NO
819840

820841
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
821842
# will remove the Files entry from the Quick Index and from the Folder Tree View
822843
# (if specified).
823844
# The default value is: YES.
824845

825-
SHOW_FILES = YES
846+
SHOW_FILES = NO
826847

827848
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
828849
# page. This will remove the Namespaces entry from the Quick Index and from the
829850
# Folder Tree View (if specified).
830851
# The default value is: YES.
831852

832-
SHOW_NAMESPACES = YES
853+
SHOW_NAMESPACES = NO
833854

834855
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
835856
# Doxygen should invoke to get the current version for each file (typically from
@@ -1336,7 +1357,7 @@ VERBATIM_HEADERS = YES
13361357
# generated with the -Duse_libclang=ON option for CMake.
13371358
# The default value is: NO.
13381359

1339-
CLANG_ASSISTED_PARSING = NO
1360+
CLANG_ASSISTED_PARSING = YES
13401361

13411362
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
13421363
# tag is set to YES then Doxygen will add the directory of each input to the
@@ -1492,7 +1513,7 @@ HTML_EXTRA_FILES =
14921513
# The default value is: AUTO_LIGHT.
14931514
# This tag requires that the tag GENERATE_HTML is set to YES.
14941515

1495-
HTML_COLORSTYLE = AUTO_LIGHT
1516+
HTML_COLORSTYLE = TOGGLE
14961517

14971518
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
14981519
# will adjust the colors in the style sheet and background images according to
@@ -1857,7 +1878,7 @@ ENUM_VALUES_PER_LINE = 4
18571878
# enumeration values besides the enumeration mnemonics.
18581879
# The default value is: NO.
18591880

1860-
SHOW_ENUM_VALUES = NO
1881+
SHOW_ENUM_VALUES = YES
18611882

18621883
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
18631884
# to set the initial width (in pixels) of the frame in which the tree is shown.
@@ -2519,15 +2540,15 @@ ENABLE_PREPROCESSING = YES
25192540
# The default value is: NO.
25202541
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
25212542

2522-
MACRO_EXPANSION = NO
2543+
MACRO_EXPANSION = YES
25232544

25242545
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
25252546
# the macro expansion is limited to the macros specified with the PREDEFINED and
25262547
# EXPAND_AS_DEFINED tags.
25272548
# The default value is: NO.
25282549
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
25292550

2530-
EXPAND_ONLY_PREDEF = NO
2551+
EXPAND_ONLY_PREDEF = YES
25312552

25322553
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
25332554
# INCLUDE_PATH will be searched if a #include is found.
@@ -2560,7 +2581,8 @@ INCLUDE_FILE_PATTERNS =
25602581
# recursively expanded use the := operator instead of the = operator.
25612582
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
25622583

2563-
PREDEFINED =
2584+
PREDEFINED = _MSTD_HAS_CXX20=1 \
2585+
_MSTD_HAS_CXX17=1
25642586

25652587
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
25662588
# tag can be used to specify a list of macro names that should be expanded. The

0 commit comments

Comments
 (0)