Skip to content

Commit 6b45a3a

Browse files
committed
Automatic doxygen documentation update - Deployed from: AcademySoftwareFoundation/openvdb a64c3ef5495bd65bd92c1ddd380b5480b8ceed7b
Signed-off-by: Idclip <[email protected]>
1 parent dd4ab0d commit 6b45a3a

18 files changed

+43
-49
lines changed

documentation/doxygen/Logger_8h_source.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

documentation/doxygen/PointExecutable_8h_source.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

documentation/doxygen/VolumeExecutable_8h_source.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

documentation/doxygen/build.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,6 @@ <h2><a class="anchor" id="buildBuildHou"></a>
256256
<tr>
257257
<td>GoogleTest </td><td>A unit testing framework module for C++ </td><td>Unit Tests </td></tr>
258258
<tr>
259-
<td>CppUnit </td><td>A unit testing framework module for C++ </td><td>Unit Tests (AX) </td></tr>
260-
<tr>
261259
<td>GLFW </td><td>Simple API for OpenGL development </td><td>OpenVDB View </td></tr>
262260
<tr>
263261
<td>Doxygen </td><td>Documentation generation from C++ </td><td>Documentation </td></tr>
@@ -312,8 +310,6 @@ <h2><a class="anchor" id="buildBuildMaya"></a>
312310
<tr>
313311
<td>GoogleTest </td><td>A unit testing framework module for C++ </td><td>Unit Tests </td></tr>
314312
<tr>
315-
<td>CppUnit </td><td>A unit testing framework module for C++ </td><td>Unit Tests (AX) </td></tr>
316-
<tr>
317313
<td>GLFW </td><td>Simple API for OpenGL development </td><td>OpenVDB View </td></tr>
318314
<tr>
319315
<td>Doxygen </td><td>Documentation generation from C++ </td><td>Documentation </td></tr>

documentation/doxygen/changes.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@
127127
<li>As of this release, LLVM 15 is the minimum required version for OpenVDB AX. Note that there is an issue with LLVM 17 symbols which makes it incompatible with the OpenVDB Python plugin. AS such, LLVM version 18 and greater are the recommended LLVM versions to use, with LLVM 18 being the new future minimum version.</li>
128128
<li>Significant performance improvement to the compilation of AX kernels when using LLVM 18 and greater.</li>
129129
<li>Significant backend refactoring to AX IR generation to support newer versions of LLVM. In particular, parts of the codegen::Function and codegen::FunctionBuilder API require new usage from LLVM 16 due to the LLVM opaque pointer changes. If you're not using the OpenVDB AX Function codegen API then no client changes should be necessary.</li>
130+
<li>Migrated OpenVDB AX unit tests from cppunit to gtest [Contributed by Tim Straubinger]</li>
130131
</ul>
131132
</li>
132133
<li>Fixes:<ul>

documentation/doxygen/classopenvdb_1_1v12__1_1_1ax_1_1Logger-members.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
<p>This is the complete list of members for <a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a>, including all inherited members.</p>
9797
<table class="directory">
98-
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#ae37f3ca373fc88722ea49a22f5446169">::TestLogger</a> class</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
98+
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#ad18aadd1014f76d68b70ca55e3778857">::TestLoggerAcc</a></td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
9999
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#a1a5edf0e2cdc9176405ae0e3ee7163ba">addNodeLocation</a>(const ax::ast::Node *node, const CodeLocation &amp;location)</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a></td><td class="entry"></td></tr>
100100
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#aabf29b105f86f2774622b7c85f19fbd4">atErrorLimit</a>() const </td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
101101
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a>()</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html">Logger</a></td><td class="entry"></td></tr>

documentation/doxygen/classopenvdb_1_1v12__1_1_1ax_1_1Logger.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,8 @@
203203
</table><table class="memberdecls">
204204
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
205205
Friends</h2></td></tr>
206-
<tr class="memitem:ae37f3ca373fc88722ea49a22f5446169"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#ae37f3ca373fc88722ea49a22f5446169">::TestLogger</a></td></tr>
207-
<tr class="separator:ae37f3ca373fc88722ea49a22f5446169"><td class="memSeparator" colspan="2">&#160;</td></tr>
206+
<tr class="memitem:ad18aadd1014f76d68b70ca55e3778857"><td class="memItemLeft" align="right" valign="top">struct&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html#ad18aadd1014f76d68b70ca55e3778857">::TestLoggerAcc</a></td></tr>
207+
<tr class="separator:ad18aadd1014f76d68b70ca55e3778857"><td class="memSeparator" colspan="2">&#160;</td></tr>
208208
</table>
209209
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
210210
<div class="textblock"><p><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1Logger.html" title="Logger for collecting errors and warnings that occur during AX compilation. ">Logger</a> for collecting errors and warnings that occur during AX compilation. </p>
@@ -942,15 +942,15 @@ <h2 class="groupheader">Member Function Documentation</h2>
942942
</div>
943943
</div>
944944
<h2 class="groupheader">Friends And Related Function Documentation</h2>
945-
<a class="anchor" id="ae37f3ca373fc88722ea49a22f5446169"></a>
945+
<a class="anchor" id="ad18aadd1014f76d68b70ca55e3778857"></a>
946946
<div class="memitem">
947947
<div class="memproto">
948948
<table class="mlabels">
949949
<tr>
950950
<td class="mlabels-left">
951951
<table class="memname">
952952
<tr>
953-
<td class="memname">friend class ::TestLogger</td>
953+
<td class="memname">friend struct ::TestLoggerAcc</td>
954954
</tr>
955955
</table>
956956
</td>

documentation/doxygen/classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable-members.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
<p>This is the complete list of members for <a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a>, including all inherited members.</p>
9797
<table class="directory">
98-
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#adfeb0ea9d4bda2e4c2a4395916b156c3">::TestPointExecutable</a> class</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
98+
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#afb134b0cfe04a4d2d8e5456ef156cd70">::TestPointExecutableAcc</a></td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
9999
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#a5f904e96618a83d59208fb22cdf11ff5">Compiler</a> class</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
100100
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#ae39043638c25771216b8f6454f24a912">execute</a>(points::PointDataGrid &amp;grid) const </td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a></td><td class="entry"></td></tr>
101101
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#a396791c4fb41a742a34dab8f5a2312fb">getAttributeBindings</a>() const </td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html">PointExecutable</a></td><td class="entry"></td></tr>

documentation/doxygen/classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@
155155
Friends</h2></td></tr>
156156
<tr class="memitem:a5f904e96618a83d59208fb22cdf11ff5"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#a5f904e96618a83d59208fb22cdf11ff5">Compiler</a></td></tr>
157157
<tr class="separator:a5f904e96618a83d59208fb22cdf11ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
158-
<tr class="memitem:adfeb0ea9d4bda2e4c2a4395916b156c3"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#adfeb0ea9d4bda2e4c2a4395916b156c3">::TestPointExecutable</a></td></tr>
159-
<tr class="separator:adfeb0ea9d4bda2e4c2a4395916b156c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
158+
<tr class="memitem:afb134b0cfe04a4d2d8e5456ef156cd70"><td class="memItemLeft" align="right" valign="top">struct&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1PointExecutable.html#afb134b0cfe04a4d2d8e5456ef156cd70">::TestPointExecutableAcc</a></td></tr>
159+
<tr class="separator:afb134b0cfe04a4d2d8e5456ef156cd70"><td class="memSeparator" colspan="2">&#160;</td></tr>
160160
</table>
161161
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
162162
<div class="textblock"><p>Object that encapsulates compiled AX code which can be executed on a collection of VDB Point Data grids. Executables are created by the compiler and hold the final immutable JIT compiled function and context. </p>
@@ -428,15 +428,15 @@ <h2 class="groupheader">Member Function Documentation</h2>
428428
</div>
429429
</div>
430430
<h2 class="groupheader">Friends And Related Function Documentation</h2>
431-
<a class="anchor" id="adfeb0ea9d4bda2e4c2a4395916b156c3"></a>
431+
<a class="anchor" id="afb134b0cfe04a4d2d8e5456ef156cd70"></a>
432432
<div class="memitem">
433433
<div class="memproto">
434434
<table class="mlabels">
435435
<tr>
436436
<td class="mlabels-left">
437437
<table class="memname">
438438
<tr>
439-
<td class="memname">friend class ::TestPointExecutable</td>
439+
<td class="memname">friend struct ::TestPointExecutableAcc</td>
440440
</tr>
441441
</table>
442442
</td>

documentation/doxygen/classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable-members.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595

9696
<p>This is the complete list of members for <a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a>, including all inherited members.</p>
9797
<table class="directory">
98-
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html#af8da9c82256fc211311bff5dfcdc1525">::TestVolumeExecutable</a> class</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
98+
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html#a05bfde7168d80e33821dfb0a9d85ea09">::TestVolumeExecutableAcc</a></td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
9999
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html#a5f904e96618a83d59208fb22cdf11ff5">Compiler</a> class</td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
100100
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html#a1a05061e87e8826cb21add59aa5611f5">execute</a>(openvdb::GridPtrVec &amp;grids) const </td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a></td><td class="entry"></td></tr>
101101
<tr><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html#ab8effd19c151d79a0aea93f1106563da">execute</a>(openvdb::GridBase &amp;grids) const </td><td class="entry"><a class="el" href="classopenvdb_1_1v12__1_1_1ax_1_1VolumeExecutable.html">VolumeExecutable</a></td><td class="entry"></td></tr>

0 commit comments

Comments
 (0)