docs(docs): updated docs and readme

This commit is contained in:
2025-11-08 10:00:16 -05:00
parent e4e7387c01
commit acff543b2d
155 changed files with 4846 additions and 4419 deletions

View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.0.0</span>
<div id="projectname">fourdst::libcomposition<span id="projectnumber">&#160;v2.0.1</span>
</div>
<div id="projectbrief">Robust atomic species information library</div>
</td>
@@ -1959,7 +1959,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if the isotope is not registered in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if the molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if the molar abundance is negative.</td></tr>
</table>
</dd>
</dl>
@@ -2005,7 +2005,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if any isotope is not registered in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if any molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if any molar abundance is negative.</td></tr>
</table>
</dd>
</dl>
@@ -2051,7 +2051,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html" title="Exception thrown when an unknown symbol is encountered.">exceptions::UnknownSymbolError</a></td><td>if any symbol is not in the atomic species database. </td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if any symbol is not in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if any molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if any molar abundance is negative.</td></tr>
</table>
</dd>
</dl>
@@ -2095,7 +2095,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html" title="Exception thrown when an unknown symbol is encountered.">exceptions::UnknownSymbolError</a></td><td>if the symbol is not in the atomic species database. </td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if the symbol is not in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if the molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if the molar abundance is negative.</td></tr>
</table>
</dd>
</dl>
@@ -2138,7 +2138,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if any isotope is not registered in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if any molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if any molar abundance is negative.</td></tr>
</table>
</dd>
</dl>
@@ -2183,7 +2183,7 @@ All species are in the <code><a class="el" href="species_8h.html">fourdst/atomic
<table class="exception">
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unknown_symbol_error.html" title="Exception thrown when an unknown symbol is encountered.">exceptions::UnknownSymbolError</a></td><td>if any symbol is not in the atomic species database. </td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error.html" title="Exception thrown when a symbol is used that has not been registered.">exceptions::UnregisteredSymbolError</a></td><td>if any symbol is not in the composition. </td></tr>
<tr><td class="paramname">exceptions::InvalidAbundanceError</td><td>if any molar abundance is negative.</td></tr>
<tr><td class="paramname"><a class="el" href="classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error.html" title="Exception thrown when a composition is in an invalid or inconsistent state.">exceptions::InvalidCompositionError</a></td><td>if any molar abundance is negative.</td></tr>
</table>
</dd>
</dl>