tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(opatIO): wrote and built doxygen docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-16 12:29:51 -05:00
parent 5ce365d545
commit 0d5406aeee
44 changed files with 711 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/html/files.html
View File

@@ -110,16 +110,12 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
<tr id="row_0_1_1_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="DObject_8h_source.html"><span class="icondoc"></span></a><a class="el" href="DObject_8h.html" target="_self">DObject.h</a></td><td class="desc">Defines the <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> class, a universal data container for the project </td></tr>
<tr id="row_0_1_1_1_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="LockableDObject_8h_source.html"><span class="icondoc"></span></a><a class="el" href="LockableDObject_8h.html" target="_self">LockableDObject.h</a></td><td class="desc">A lightweight wrapper for <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> that adds locking capabilities </td></tr>
<tr id="row_0_1_1_2_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="Metadata_8h_source.html"><span class="icondoc"></span></a><a class="el" href="Metadata_8h.html" target="_self">Metadata.h</a></td><td class="desc">Public interface for the <a class="el" href="classMetadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> class used in the dobj module </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><span id="img_0_2_" class="iconfopen" onclick="toggleFolder('0_2_')">&#160;</span><a class="el" href="dir_5300298560c4bf255ab9f36681603d89.html" target="_self">mapping</a></td><td class="desc"></td></tr>
<tr id="row_0_2_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_2_0_" class="arrow" onclick="toggleFolder('0_2_0_')">&#9660;</span><span id="img_0_2_0_" class="iconfopen" onclick="toggleFolder('0_2_0_')">&#160;</span><a class="el" href="dir_01375c4291ef81af6b426b22dfef59b0.html" target="_self">private</a></td><td class="desc"></td></tr>
<tr id="row_0_2_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="grid_8h_source.html"><span class="icondoc"></span></a><b>grid.h</b></td><td class="desc"></td></tr>
<tr id="row_0_2_0_1_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="mapper_8h_source.html"><span class="icondoc"></span></a><b>mapper.h</b></td><td class="desc"></td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span id="img_0_3_" class="iconfopen" onclick="toggleFolder('0_3_')">&#160;</span><a class="el" href="dir_7be0d8c199b9408ae01f5d77515b8def.html" target="_self">mesh</a></td><td class="desc"></td></tr>
<tr id="row_0_3_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_3_0_" class="arrow" onclick="toggleFolder('0_3_0_')">&#9660;</span><span id="img_0_3_0_" class="iconfopen" onclick="toggleFolder('0_3_0_')">&#160;</span><a class="el" href="dir_6f7ea45c988f41ae8b133398f644b0ed.html" target="_self">public</a></td><td class="desc"></td></tr>
<tr id="row_0_3_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="mesh_8h_source.html"><span class="icondoc"></span></a><b>mesh.h</b></td><td class="desc"></td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_4_" class="arrow" onclick="toggleFolder('0_4_')">&#9660;</span><span id="img_0_4_" class="iconfopen" onclick="toggleFolder('0_4_')">&#160;</span><a class="el" href="dir_98811334950283dfb0b975440d5272eb.html" target="_self">opac</a></td><td class="desc"></td></tr>
<tr id="row_0_4_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_4_0_" class="arrow" onclick="toggleFolder('0_4_0_')">&#9660;</span><span id="img_0_4_0_" class="iconfopen" onclick="toggleFolder('0_4_0_')">&#160;</span><a class="el" href="dir_88e1407a1fb38d630626d3e1b6639cc8.html" target="_self">public</a></td><td class="desc"></td></tr>
<tr id="row_0_4_0_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="opac_8h_source.html"><span class="icondoc"></span></a><b>opac.h</b></td><td class="desc"></td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><span id="img_0_2_" class="iconfopen" onclick="toggleFolder('0_2_')">&#160;</span><a class="el" href="dir_98811334950283dfb0b975440d5272eb.html" target="_self">opac</a></td><td class="desc"></td></tr>
<tr id="row_0_2_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_2_0_" class="arrow" onclick="toggleFolder('0_2_0_')">&#9660;</span><span id="img_0_2_0_" class="iconfopen" onclick="toggleFolder('0_2_0_')">&#160;</span><a class="el" href="dir_88e1407a1fb38d630626d3e1b6639cc8.html" target="_self">public</a></td><td class="desc"></td></tr>
<tr id="row_0_2_0_0_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="opac_8h_source.html"><span class="icondoc"></span></a><b>opac.h</b></td><td class="desc"></td></tr>
<tr id="row_0_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span id="img_0_3_" class="iconfopen" onclick="toggleFolder('0_3_')">&#160;</span><a class="el" href="dir_dc4574cef47f5b50114efcdd6e195baf.html" target="_self">opatIO</a></td><td class="desc"></td></tr>
<tr id="row_0_3_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_3_0_" class="arrow" onclick="toggleFolder('0_3_0_')">&#9660;</span><span id="img_0_3_0_" class="iconfopen" onclick="toggleFolder('0_3_0_')">&#160;</span><a class="el" href="dir_a105e00bd9bc580163f6cfcc237f0c76.html" target="_self">public</a></td><td class="desc"></td></tr>
<tr id="row_0_3_0_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><a href="opatIO_8h_source.html"><span class="icondoc"></span></a><b>opatIO.h</b></td><td class="desc"></td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span id="img_1_" class="iconfopen" onclick="toggleFolder('1_')">&#160;</span><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.html" target="_self">tests</a></td><td class="desc"></td></tr>
<tr id="row_1_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_1_0_" class="arrow" onclick="toggleFolder('1_0_')">&#9660;</span><span id="img_1_0_" class="iconfopen" onclick="toggleFolder('1_0_')">&#160;</span><a class="el" href="dir_6cfc89239232d12b3feb44b30f54e02f.html" target="_self">const</a></td><td class="desc"></td></tr>
<tr id="row_1_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="constTest_8cpp.html" target="_self">constTest.cpp</a></td><td class="desc">Unit tests for the const class </td></tr>
@@ -127,6 +123,8 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); });
<tr id="row_1_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="DObjectTest_8cpp.html" target="_self">DObjectTest.cpp</a></td><td class="desc">Unit tests for the <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> class </td></tr>
<tr id="row_1_1_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="LockableDObjectTest_8cpp.html" target="_self">LockableDObjectTest.cpp</a></td><td class="desc">Unit tests for the <a class="el" href="classLockableDObject.html" title="Wrapper for DObject with thread-safe access.">LockableDObject</a> class </td></tr>
<tr id="row_1_1_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="MetadataTest_8cpp.html" target="_self">MetadataTest.cpp</a></td><td class="desc">Unit tests and integration tests for the <a class="el" href="classMetadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> class </td></tr>
<tr id="row_1_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_1_2_" class="arrow" onclick="toggleFolder('1_2_')">&#9660;</span><span id="img_1_2_" class="iconfopen" onclick="toggleFolder('1_2_')">&#160;</span><a class="el" href="dir_a0668aa070a38eaa8236727e19a9b15f.html" target="_self">opatIO</a></td><td class="desc"></td></tr>
<tr id="row_1_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icondoc"></span><a class="el" href="opatIOTest_8cpp.html" target="_self">opatIOTest.cpp</a></td><td class="desc">Unit tests for the <a class="el" href="classOpatIO.html" title="Class to manage the input/output operations for OPAT files.">OpatIO</a> class and associated structs </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->