Skip to content

Commit 3e6215a

Browse files
kwokcbkwokcb
committed
Fix doxygen files.
1 parent 46a5ee1 commit 3e6215a

98 files changed

Lines changed: 9560 additions & 604 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.

‎documents/Doxyfile‎

Lines changed: 168 additions & 109 deletions
Large diffs are not rendered by default.

‎documents/Doxyfile.bak‎

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = MaterialXMaterials
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 1.39.5
51+
PROJECT_NUMBER = 0.0.3
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a
@@ -359,7 +359,6 @@ EXTENSION_MAPPING = js=javascript
359359
# The default value is: YES.
360360

361361
MARKDOWN_SUPPORT = YES
362-
ALLOW_HTML_OUTPUT = YES
363362

364363
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
365364
# to that level are automatically included in the table of contents, even if
@@ -1277,6 +1276,46 @@ USE_HTAGS = NO
12771276

12781277
VERBATIM_HEADERS = YES
12791278

1279+
# If the CLANG_ASSISTED_PARSING tag is set to YES then Doxygen will use the
1280+
# clang parser (see:
1281+
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
1282+
# performance. This can be particularly helpful with template rich C++ code for
1283+
# which Doxygen's built-in parser lacks the necessary type information.
1284+
# Note: The availability of this option depends on whether or not Doxygen was
1285+
# generated with the -Duse_libclang=ON option for CMake.
1286+
# The default value is: NO.
1287+
1288+
CLANG_ASSISTED_PARSING = NO
1289+
1290+
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
1291+
# tag is set to YES then Doxygen will add the directory of each input to the
1292+
# include path.
1293+
# The default value is: YES.
1294+
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1295+
1296+
CLANG_ADD_INC_PATHS = YES
1297+
1298+
# If clang assisted parsing is enabled you can provide the compiler with command
1299+
# line options that you would normally use when invoking the compiler. Note that
1300+
# the include paths will already be set by Doxygen for the files and directories
1301+
# specified with INPUT and INCLUDE_PATH.
1302+
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1303+
1304+
CLANG_OPTIONS =
1305+
1306+
# If clang assisted parsing is enabled you can provide the clang parser with the
1307+
# path to the directory containing a file called compile_commands.json. This
1308+
# file is the compilation database (see:
1309+
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
1310+
# options used when the source files were built. This is equivalent to
1311+
# specifying the -p option to a clang tool, such as clang-check. These options
1312+
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
1313+
# will be added as well.
1314+
# Note: The availability of this option depends on whether or not Doxygen was
1315+
# generated with the -Duse_libclang=ON option for CMake.
1316+
1317+
CLANG_DATABASE_PATH =
1318+
12801319
#---------------------------------------------------------------------------
12811320
# Configuration options related to the alphabetical class index
12821321
#---------------------------------------------------------------------------

‎documents/doxygen_warnings.txt‎

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
warning: Specified markdown mainpage 'README.md' does not exist
2-
/Users/bernardkwok/work/materialxMaterials/README.md:1: warning: No matching directory found for command \dir /Users/bernardkwok/work/materialxMaterials/
3-
/Users/bernardkwok/work/materialxMaterials/myserver.py:8: warning: Compound myserver::MyHTTPRequestHandler is not documented.
41
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/physicallyBasedMaterialXCmd.py:24: warning: Member physicallBasedMaterialXCmd() (function) of namespace materialxMaterials.physicallyBasedMaterialXCmd is not documented.
52
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/polyHavenLoaderCmd.py:14: warning: Member main() (function) of namespace materialxMaterials.polyHavenLoaderCmd is not documented.
63
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/polyHavenLoaderCmd.py:11: warning: Member logger (variable) of namespace materialxMaterials.polyHavenLoaderCmd is not documented.
@@ -10,17 +7,58 @@ warning: Specified markdown mainpage 'README.md' does not exist
107
parameter 'listNumber'
118
parameter 'materialNumber'
129
parameter 'packageId'
10+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:122: warning: argument 'number' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::downloadPackage(listNumber, materialNumber, packageId=0)
11+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:122: warning: The following parameters of JsGPUOpenMaterialLoader::downloadPackage(listNumber, materialNumber, packageId=0) are not documented:
12+
parameter 'listNumber'
13+
parameter 'materialNumber'
14+
parameter 'packageId'
1315
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:220: warning: argument 'string' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0)
1416
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:220: warning: argument 'number' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0)
1517
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:220: warning: The following parameters of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0) are not documented:
1618
parameter 'searchExpr'
1719
parameter 'packageId'
20+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:220: warning: argument 'string' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0)
21+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:220: warning: argument 'number' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0)
22+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:220: warning: The following parameters of JsGPUOpenMaterialLoader::downloadPackageByExpression(searchExpr, packageId=0) are not documented:
23+
parameter 'searchExpr'
24+
parameter 'packageId'
1825
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:180: warning: argument 'string' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::findMaterialsByName(materialName)
1926
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:180: warning: The following parameter of JsGPUOpenMaterialLoader::findMaterialsByName(materialName) is not documented:
2027
parameter 'materialName'
28+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:180: warning: argument 'string' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::findMaterialsByName(materialName)
29+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:180: warning: The following parameter of JsGPUOpenMaterialLoader::findMaterialsByName(materialName) is not documented:
30+
parameter 'materialName'
2131
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:47: warning: argument 'number' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::getMaterials(batchSize=50)
2232
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoader.js:47: warning: The following parameter of JsGPUOpenMaterialLoader::getMaterials(batchSize=50) is not documented:
2333
parameter 'batchSize'
34+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:47: warning: argument 'number' of command @param is not found in the argument list of JsGPUOpenMaterialLoader::getMaterials(batchSize=50)
35+
/Users/bernardkwok/work/materialxMaterials/javascript/JsGPUOpenLoaderPackage/JsGPUOpenLoader.js:47: warning: The following parameter of JsGPUOpenMaterialLoader::getMaterials(batchSize=50) is not documented:
36+
parameter 'batchSize'
37+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:6: warning: Member constructor() (function) of class PolyHavenAPI is not documented.
38+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:167: warning: argument 'Object' of command @param is not found in the argument list of PolyHavenAPI::createMaterialXPackage(material, resolution)
39+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:167: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::createMaterialXPackage(material, resolution)
40+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:167: warning: The following parameters of PolyHavenAPI::createMaterialXPackage(material, resolution) are not documented:
41+
parameter 'material'
42+
parameter 'resolution'
43+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:101: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::downloadMaterialXContent(url)
44+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:101: warning: The following parameter of PolyHavenAPI::downloadMaterialXContent(url) is not documented:
45+
parameter 'url'
46+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:123: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::downloadTexture(url)
47+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:123: warning: The following parameter of PolyHavenAPI::downloadTexture(url) is not documented:
48+
parameter 'url'
49+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:145: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::downloadThumbnail(thumbnailUrl)
50+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:145: warning: The following parameter of PolyHavenAPI::downloadThumbnail(thumbnailUrl) is not documented:
51+
parameter 'thumbnailUrl'
52+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:79: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::fetchMaterialFiles(materialId)
53+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:79: warning: The following parameter of PolyHavenAPI::fetchMaterialFiles(materialId) is not documented:
54+
parameter 'materialId'
55+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:255: warning: argument 'string' of command @param is not found in the argument list of PolyHavenAPI::getMaterialContent(materialId, resolution)
56+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:255: warning: The following parameters of PolyHavenAPI::getMaterialContent(materialId, resolution) are not documented:
57+
parameter 'materialId'
58+
parameter 'resolution'
59+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:35: warning: argument 'Object' of command @param is not found in the argument list of PolyHavenAPI::processMaterialsData(rawData)
60+
/Users/bernardkwok/work/materialxMaterials/javascript/JsPolyHaven/PolyHavenFetch.js:35: warning: The following parameter of PolyHavenAPI::processMaterialsData(rawData) is not documented:
61+
parameter 'rawData'
2462
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/physicallyBasedMaterialX.py:313: warning: Member _getMethodName(self) (function) of class materialxMaterials.physicallyBasedMaterialX.PhysicallyBasedMaterialLoader is not documented.
2563
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/physicallyBasedMaterialX.py:189: warning: argument 'filename' of command @param is not found in the argument list of materialxMaterials.physicallyBasedMaterialX.PhysicallyBasedMaterialLoader::readRemappingFile(self, filepath)
2664
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/physicallyBasedMaterialX.py:189: warning: The following parameter of materialxMaterials.physicallyBasedMaterialX.PhysicallyBasedMaterialLoader.readRemappingFile(self, filepath) is not documented:
@@ -38,4 +76,6 @@ warning: Specified markdown mainpage 'README.md' does not exist
3876
/Users/bernardkwok/work/materialxMaterials/src/materialxMaterials/polyHavenLoader.py:34: warning: The following parameters of materialxMaterials.polyHavenLoader.PolyHavenLoader.fetch_materialx_assets(self, max_items=1, download_id=None) are not documented:
3977
parameter 'max_items'
4078
parameter 'download_id'
41-
/Users/bernardkwok/work/materialxMaterials/myserver.py:9: warning: Member end_headers(self) (function) of class myserver.MyHTTPRequestHandler is not documented.
79+
/Users/bernardkwok/work/materialxMaterials/README.md:58: warning: Unsupported xml/html tag <iframe> found
80+
/Users/bernardkwok/work/materialxMaterials/README.md:59: warning: Unsupported xml/html tag </iframe> found
81+
/Users/bernardkwok/work/materialxMaterials/README.md:331: warning: end of comment block while expecting command </div> (Probable start '/Users/bernardkwok/work/materialxMaterials/README.md' at line 330)

‎documents/html/____init_____8py_source.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.15.0"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>MaterialXMaterials: __init__.py Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -27,7 +27,7 @@
2727
<tbody>
2828
<tr id="projectrow">
2929
<td id="projectalign">
30-
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;0.0.3</span>
30+
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;1.39.5</span>
3131
</div>
3232
<div id="projectbrief">Utilities for retrieving materials from remote servers</div>
3333
</td>
@@ -36,7 +36,7 @@
3636
</table>
3737
</div>
3838
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.15.0 -->
39+
<!-- Generated by Doxygen 1.16.1 -->
4040
<script type="text/javascript">
4141
var searchBox = new SearchBox("searchBox", "search/",'.html');
4242
</script>
@@ -101,7 +101,7 @@
101101
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
102102
<ul>
103103
<li class="navelem"><b>src</b></li><li class="navelem"><b>materialxMaterials</b></li><li class="navelem"><b>__init__.py</b></li>
104-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
104+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
105105
</ul>
106106
</div>
107107
</body>

‎documents/html/____main_____8py_source.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.15.0"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>MaterialXMaterials: __main__.py Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -27,7 +27,7 @@
2727
<tbody>
2828
<tr id="projectrow">
2929
<td id="projectalign">
30-
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;0.0.3</span>
30+
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;1.39.5</span>
3131
</div>
3232
<div id="projectbrief">Utilities for retrieving materials from remote servers</div>
3333
</td>
@@ -36,7 +36,7 @@
3636
</table>
3737
</div>
3838
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.15.0 -->
39+
<!-- Generated by Doxygen 1.16.1 -->
4040
<script type="text/javascript">
4141
var searchBox = new SearchBox("searchBox", "search/",'.html');
4242
</script>
@@ -138,7 +138,7 @@
138138
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
139139
<ul>
140140
<li class="navelem"><b>src</b></li><li class="navelem"><b>materialxMaterials</b></li><li class="navelem"><b>__main__.py</b></li>
141-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
141+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
142142
</ul>
143143
</div>
144144
</body>

‎documents/html/_g_p_u_open_loader_8py_source.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.15.0"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>MaterialXMaterials: GPUOpenLoader.py Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -27,7 +27,7 @@
2727
<tbody>
2828
<tr id="projectrow">
2929
<td id="projectalign">
30-
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;0.0.3</span>
30+
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;1.39.5</span>
3131
</div>
3232
<div id="projectbrief">Utilities for retrieving materials from remote servers</div>
3333
</td>
@@ -36,7 +36,7 @@
3636
</table>
3737
</div>
3838
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.15.0 -->
39+
<!-- Generated by Doxygen 1.16.1 -->
4040
<script type="text/javascript">
4141
var searchBox = new SearchBox("searchBox", "search/",'.html');
4242
</script>
@@ -545,7 +545,7 @@
545545
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
546546
<ul>
547547
<li class="navelem"><b>src</b></li><li class="navelem"><b>materialxMaterials</b></li><li class="navelem"><b>GPUOpenLoader.py</b></li>
548-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
548+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
549549
</ul>
550550
</div>
551551
</body>

‎documents/html/_g_p_u_open_loader_cmd_8py_source.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.15.0"/>
6+
<meta name="generator" content="Doxygen 1.16.1"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>MaterialXMaterials: GPUOpenLoaderCmd.py Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -27,7 +27,7 @@
2727
<tbody>
2828
<tr id="projectrow">
2929
<td id="projectalign">
30-
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;0.0.3</span>
30+
<div id="projectname">MaterialXMaterials<span id="projectnumber">&#160;1.39.5</span>
3131
</div>
3232
<div id="projectbrief">Utilities for retrieving materials from remote servers</div>
3333
</td>
@@ -36,7 +36,7 @@
3636
</table>
3737
</div>
3838
<!-- end header part -->
39-
<!-- Generated by Doxygen 1.15.0 -->
39+
<!-- Generated by Doxygen 1.16.1 -->
4040
<script type="text/javascript">
4141
var searchBox = new SearchBox("searchBox", "search/",'.html');
4242
</script>
@@ -204,7 +204,7 @@
204204
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
205205
<ul>
206206
<li class="navelem"><b>src</b></li><li class="navelem"><b>materialxMaterials</b></li><li class="navelem"><b>GPUOpenLoaderCmd.py</b></li>
207-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
207+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
208208
</ul>
209209
</div>
210210
</body>

0 commit comments

Comments
 (0)
⚡