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

docs(config): rebuild docs and removed redundant documentation

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-20 09:45:47 -05:00
parent 796d8a9021
commit e54a5be967
38 changed files with 291 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/html/annotated.html
View File

@@ -102,23 +102,24 @@ $(document).ready(function(){initNavTree('annotated.html',''); initResizable();
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classCompositeNonlinearIntegrator.html" target="_self">CompositeNonlinearIntegrator</a></td><td class="desc">A class for composite nonlinear integrator </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConfig.html" target="_self">Config</a></td><td class="desc">Singleton class to manage configuration settings loaded from a YAML file </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconfigTest.html" target="_self">configTest</a></td><td class="desc">Test suite for the <a class="el" href="classConfig.html" title="Singleton class to manage configuration settings loaded from a YAML file.">Config</a> class </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structConstant.html" target="_self">Constant</a></td><td class="desc">Structure to hold a constant's details </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConstants.html" target="_self">Constants</a></td><td class="desc">Class to manage a collection of constants </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconstTest.html" target="_self">constTest</a></td><td class="desc">Test suite for the const class </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classDObject.html" target="_self">DObject</a></td><td class="desc">A universal data container class </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classDObjectTest.html" target="_self">DObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> class </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structHeader.html" target="_self">Header</a></td><td class="desc">Structure to hold the header information of an OPAT file </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLockableDObject.html" target="_self">LockableDObject</a></td><td class="desc">Wrapper for <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> with thread-safe access </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLockableDObjectTest.html" target="_self">LockableDObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="classLockableDObject.html" title="Wrapper for DObject with thread-safe access.">LockableDObject</a> class </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMeshIO.html" target="_self">MeshIO</a></td><td class="desc">Class for handling mesh input/output operations </td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmeshIOTest.html" target="_self">meshIOTest</a></td><td class="desc"></td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMetadata.html" target="_self">Metadata</a></td><td class="desc">Represents metadata information for data objects in the dobj module </td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMetadataTest.html" target="_self">MetadataTest</a></td><td class="desc">Test suite 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_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNonlinearPowerIntegrator.html" target="_self">NonlinearPowerIntegrator</a></td><td class="desc">A class for nonlinear power integrator </td></tr>
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classOpatIO.html" target="_self">OpatIO</a></td><td class="desc">Class to manage the input/output operations for OPAT files </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classopatIOTest.html" target="_self">opatIOTest</a></td><td class="desc">Test suite for the const class </td></tr>
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structOPATTable.html" target="_self">OPATTable</a></td><td class="desc">Structure to hold the data of an OPAT table </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTableIndex.html" target="_self">TableIndex</a></td><td class="desc">Structure to hold the index information of a table in an OPAT file </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconfigTestPrivateAccessor.html" target="_self">configTestPrivateAccessor</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structConstant.html" target="_self">Constant</a></td><td class="desc">Structure to hold a constant's details </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConstants.html" target="_self">Constants</a></td><td class="desc">Class to manage a collection of constants </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classconstTest.html" target="_self">constTest</a></td><td class="desc">Test suite for the const class </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classDObject.html" target="_self">DObject</a></td><td class="desc">A universal data container class </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classDObjectTest.html" target="_self">DObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> class </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structHeader.html" target="_self">Header</a></td><td class="desc">Structure to hold the header information of an OPAT file </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLockableDObject.html" target="_self">LockableDObject</a></td><td class="desc">Wrapper for <a class="el" href="classDObject.html" title="A universal data container class.">DObject</a> with thread-safe access </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classLockableDObjectTest.html" target="_self">LockableDObjectTest</a></td><td class="desc">Test suite for the <a class="el" href="classLockableDObject.html" title="Wrapper for DObject with thread-safe access.">LockableDObject</a> class </td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMeshIO.html" target="_self">MeshIO</a></td><td class="desc">Class for handling mesh input/output operations </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmeshIOTest.html" target="_self">meshIOTest</a></td><td class="desc"></td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMetadata.html" target="_self">Metadata</a></td><td class="desc">Represents metadata information for data objects in the dobj module </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMetadataTest.html" target="_self">MetadataTest</a></td><td class="desc">Test suite 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_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNonlinearPowerIntegrator.html" target="_self">NonlinearPowerIntegrator</a></td><td class="desc">A class for nonlinear power integrator </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classOpatIO.html" target="_self">OpatIO</a></td><td class="desc">Class to manage the input/output operations for OPAT files </td></tr>
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classopatIOTest.html" target="_self">opatIOTest</a></td><td class="desc">Test suite for the const class </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structOPATTable.html" target="_self">OPATTable</a></td><td class="desc">Structure to hold the data of an OPAT table </td></tr>
<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTableIndex.html" target="_self">TableIndex</a></td><td class="desc">Structure to hold the index information of a table in an OPAT file </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->