-
Notifications
You must be signed in to change notification settings - Fork 45
/
Doxyfile
147 lines (101 loc) · 5.52 KB
/
Doxyfile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# This file was initially generated by Doxyfile 1.10.0 and all entries left
# to their default value have been removed for the sake of clarity.
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = "WebGPU Headers"
# This is the version of webgpu.h. Currently we don't have release versions.
PROJECT_NUMBER =
# This appears at the top of each page and should give viewer a quick idea
# about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "The WebGPU C API"
# The Doxygen-generated documentation is written in doc/generated. Make sure
# to keep this in sync with the deployment workflow file
# (.github/workflows/gen-docs.yml).
OUTPUT_DIRECTORY = doc/generated
# Since webgpu.h is a C API, we set the OPTIMIZE_OUTPUT_FOR_C tag to YES so
# that Doxygen generates an output that is more tailored for C.
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
EXTRACT_STATIC = YES
WARN_AS_ERROR = FAIL_ON_WARNINGS
WARN_IF_INCOMPLETE_DOC = NO
# Note EXTRACT_ALL bypasses these, but keep them in case we disable it.
WARN_IF_UNDOC_ENUM_VAL = YES
WARN_NO_PARAMDOC = NO
WARN_IF_UNDOCUMENTED = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
# The WebGPU C API does not have cases of symbols only differing by case, so
# we can afford to turn this to YES even on non-case sensitive file systems.
# This options helps getting slightly better path names, although it is still
# overall not satisfying so as soon as we have a proper way to generate good
# human-memorable URLs we could turn this back to NO or SYSTEM.
CASE_SENSE_NAMES = YES
# No need to show header file, since there is only webgpu.h. When using this
# Doxyfile with implementation-specific extensions (e.g., wgpu.h), it could
# be useful to turn this back to YES.
SHOW_HEADERFILE = NO
# Instead of letting Doxygen sort definition alphabetically, we have it rely
# on the order from webgpu.h. Since the latter is auto-generated, we can
# expect the order there to be sound and consistent.
SORT_MEMBER_DOCS = NO
# No need to show used files as there is only webgpu.h
SHOW_USED_FILES = NO
# And no need for the Files page neither.
SHOW_FILES = NO
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. To create the layout file
# that represents doxygen's defaults, run doxygen with the -l option. You can
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
# will be used as the name of the layout file. See also section "Changing the
# layout of pages" for information.
#
# Note that if you run doxygen from a directory containing a file called
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
# When adding extra files, separate them with spaces.
INPUT = webgpu.h doc/articles/
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
# The header file itself is often a good source of information, so we have
# documented entries be cross-referenced with their source.
SOURCE_BROWSER = YES
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# Make sure the WGPU/wgpu prefix of type/function names are ignored while
# sorting member names in the alphabetical index.
IGNORE_PREFIX = WGPU,wgpu
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = YES
# Sidebar-based page layout (https://www.doxygen.nl/manual/customize.html)
DISABLE_INDEX = YES
GENERATE_TREEVIEW = YES
FULL_SIDEBAR = YES
# Enum values look weird in Doxygen output in general, but a bit less weird
# when only allowing 1 value per line.
ENUM_VALUES_PER_LINE = 1
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# We do not need a LaTeX documentation
GENERATE_LATEX = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# We need to expand macros to prevent the empty defines used as tags like
# WGPU_ENUM_ATTRIBUTE to be treated by Doxygen and mess up with the whole
# documentation.
MACRO_EXPANSION = YES