From 0e89587db3ebee4d463f191bd296374c5fafc8ea Mon Sep 17 00:00:00 2001 From: Adam Sawicki Date: Tue, 2 May 2023 12:44:06 +0200 Subject: [PATCH] Updated Doxyfile for Doxygen 1.9.6 Regenerated documentation. Fixes #335 --- Doxyfile | 138 ++++--- bin/Shader.frag.spv | Bin 1004 -> 1004 bytes bin/Shader.vert.spv | Bin 1472 -> 1472 bytes docs/html/allocation_annotation.html | 18 +- docs/html/annotated.html | 6 +- docs/html/choosing_memory_type.html | 42 +-- docs/html/classes.html | 6 +- docs/html/configuration.html | 32 +- docs/html/custom_memory_pools.html | 60 +-- docs/html/debugging_memory_usage.html | 46 +-- docs/html/defragmentation.html | 28 +- docs/html/deprecated.html | 6 +- .../dir_d44c64559bbebec7f509842c48db8b23.html | 6 +- docs/html/doxygen.css | 64 +++- docs/html/enabling_buffer_device_address.html | 28 +- docs/html/files.html | 6 +- docs/html/functions.html | 6 +- docs/html/functions_vars.html | 6 +- docs/html/general_considerations.html | 16 +- docs/html/globals.html | 6 +- docs/html/globals_defs.html | 6 +- docs/html/globals_enum.html | 6 +- docs/html/globals_eval.html | 6 +- docs/html/globals_func.html | 6 +- docs/html/globals_type.html | 6 +- docs/html/group__group__alloc.html | 354 +++++++++--------- docs/html/group__group__init.html | 102 ++--- docs/html/group__group__stats.html | 40 +- docs/html/group__group__virtual.html | 80 ++-- docs/html/index.html | 12 +- docs/html/memory_mapping.html | 24 +- docs/html/modules.html | 6 +- docs/html/opengl_interop.html | 24 +- docs/html/pages.html | 6 +- docs/html/quick_start.html | 36 +- docs/html/resource_aliasing.html | 22 +- docs/html/statistics.html | 22 +- docs/html/staying_within_budget.html | 24 +- docs/html/struct_vma_allocation.html | 16 +- ...ct_vma_allocation_create_info-members.html | 6 +- .../struct_vma_allocation_create_info.html | 40 +- .../struct_vma_allocation_info-members.html | 6 +- docs/html/struct_vma_allocation_info.html | 44 +-- docs/html/struct_vma_allocator.html | 12 +- ...uct_vma_allocator_create_info-members.html | 6 +- .../struct_vma_allocator_create_info.html | 58 +-- .../struct_vma_allocator_info-members.html | 6 +- docs/html/struct_vma_allocator_info.html | 20 +- docs/html/struct_vma_budget-members.html | 6 +- docs/html/struct_vma_budget.html | 24 +- .../struct_vma_defragmentation_context.html | 10 +- ...ruct_vma_defragmentation_info-members.html | 6 +- .../html/struct_vma_defragmentation_info.html | 24 +- ...ruct_vma_defragmentation_move-members.html | 6 +- .../html/struct_vma_defragmentation_move.html | 14 +- ...efragmentation_pass_move_info-members.html | 6 +- ...ct_vma_defragmentation_pass_move_info.html | 26 +- ...uct_vma_defragmentation_stats-members.html | 6 +- .../struct_vma_defragmentation_stats.html | 16 +- ...truct_vma_detailed_statistics-members.html | 6 +- docs/html/struct_vma_detailed_statistics.html | 24 +- ...t_vma_device_memory_callbacks-members.html | 6 +- .../struct_vma_device_memory_callbacks.html | 18 +- docs/html/struct_vma_pool.html | 12 +- .../struct_vma_pool_create_info-members.html | 6 +- docs/html/struct_vma_pool_create_info.html | 42 +-- docs/html/struct_vma_statistics-members.html | 6 +- docs/html/struct_vma_statistics.html | 22 +- .../struct_vma_total_statistics-members.html | 6 +- docs/html/struct_vma_total_statistics.html | 10 +- docs/html/struct_vma_virtual_allocation.html | 12 +- ...irtual_allocation_create_info-members.html | 6 +- ...ct_vma_virtual_allocation_create_info.html | 22 +- ...t_vma_virtual_allocation_info-members.html | 6 +- .../struct_vma_virtual_allocation_info.html | 20 +- docs/html/struct_vma_virtual_block.html | 12 +- ...vma_virtual_block_create_info-members.html | 6 +- .../struct_vma_virtual_block_create_info.html | 18 +- .../struct_vma_vulkan_functions-members.html | 6 +- docs/html/struct_vma_vulkan_functions.html | 26 +- docs/html/usage_patterns.html | 32 +- docs/html/virtual_allocator.html | 40 +- docs/html/vk__mem__alloc_8h.html | 196 +++++----- docs/html/vk_amd_device_coherent_memory.html | 28 +- docs/html/vk_ext_memory_priority.html | 30 +- docs/html/vk_khr_dedicated_allocation.html | 28 +- 86 files changed, 1192 insertions(+), 1114 deletions(-) diff --git a/Doxyfile b/Doxyfile index aa0dfef..7aac8fa 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.9.4 +# Doxyfile 1.9.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -19,7 +19,8 @@ # configuration file: # doxygen -x [configFile] # Use doxygen to compare the used configuration file with the template -# configuration file without replacing the environment variables: +# configuration file without replacing the environment variables or CMake type +# replacement variables: # doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- @@ -85,7 +86,7 @@ CREATE_SUBDIRS = NO # level increment doubles the number of directories, resulting in 4096 # directories at level 8 which is the default and also the maximum value. The # sub-directories are organized in 2 levels, the first level always has a fixed -# numer of 16 directories. +# number of 16 directories. # Minimum value: 0, maximum value: 8, default value: 8. # This tag requires that the tag CREATE_SUBDIRS is set to YES. @@ -567,7 +568,8 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO @@ -605,7 +607,8 @@ INTERNAL_DOCS = NO # Windows (including Cygwin) and MacOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. -# The default value is: system dependent. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = NO @@ -857,6 +860,14 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but @@ -913,10 +924,21 @@ INPUT = "@CMAKE_SOURCE_DIR@/include/vk_mem_alloc.h" # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. @@ -1063,6 +1085,11 @@ IMAGE_PATH = # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. @@ -1104,6 +1131,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -1241,10 +1277,11 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = @@ -1323,7 +1360,12 @@ HTML_STYLESHEET = # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1338,6 +1380,19 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a color-wheel, see @@ -1701,17 +1756,6 @@ HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -2436,26 +2480,38 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" + +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = @@ -2698,18 +2754,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support diff --git a/bin/Shader.frag.spv b/bin/Shader.frag.spv index 05bdb6a0fdc8eab86b1cf425ab302f40578d85ba..065a803b28ec0be3645b15e487bbbdf58aaa08c3 100644 GIT binary patch delta 18 ZcmaFE{)U~CnMs+Qfq{{Mdn4y#W&kI&1Iqva delta 18 ZcmaFE{)U~CnMs+Qfq{{MYa{1lW&kIz1IhpZ diff --git a/bin/Shader.vert.spv b/bin/Shader.vert.spv index 1643374cc1c7b6ad1e6493fb69e6bc660f361b84..8a568e78ce8802e08fb0c27f119d7c13f7dfafdc 100644 GIT binary patch delta 18 ZcmX@WeSn*jnMs+Qfq{{Mdn4y|RsbRf15p3~ delta 18 ZcmX@WeSn*jnMs+Qfq{{MYa{1&RsbRa15f|} diff --git a/docs/html/allocation_annotation.html b/docs/html/allocation_annotation.html index 01151dc..9cef5b9 100644 --- a/docs/html/allocation_annotation.html +++ b/docs/html/allocation_annotation.html @@ -3,7 +3,7 @@ - + Vulkan Memory Allocator: Allocation names and user data @@ -29,7 +29,7 @@ - +