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

docs(docs): updated docs and readme

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-08 10:00:16 -05:00
parent e4e7387c01
commit acff543b2d
155 changed files with 4846 additions and 4419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/composition/include/fourdst/composition/composition.h
View File

@@ -387,7 +387,7 @@ namespace fourdst::composition {
*
* @throws exceptions::UnknownSymbolError if the symbol is not in the atomic species database.
* @throws exceptions::UnregisteredSymbolError if the symbol is not in the composition.
* @throws exceptions::InvalidAbundanceError if the molar abundance is negative.
* @throws exceptions::InvalidCompositionError if the molar abundance is negative.
*
* @par Example:
* @code
@@ -407,7 +407,7 @@ namespace fourdst::composition {
* @param molar_abundance The molar abundance to set.
*
* @throws exceptions::UnregisteredSymbolError if the isotope is not registered in the composition.
* @throws exceptions::InvalidAbundanceError if the molar abundance is negative.
* @throws exceptions::InvalidCompositionError if the molar abundance is negative.
*
* @par Example:
* @code
@@ -432,7 +432,7 @@ namespace fourdst::composition {
*
* @throws exceptions::UnknownSymbolError if any symbol is not in the atomic species database.
* @throws exceptions::UnregisteredSymbolError if any symbol is not in the composition.
* @throws exceptions::InvalidAbundanceError if any molar abundance is negative.
* @throws exceptions::InvalidCompositionError if any molar abundance is negative.
*
* @par Example:
* @code
@@ -451,7 +451,7 @@ namespace fourdst::composition {
* @param molar_abundances The molar abundances to set.
*
* @throws exceptions::UnregisteredSymbolError if any isotope is not registered in the composition.
* @throws exceptions::InvalidAbundanceError if any molar abundance is negative.
* @throws exceptions::InvalidCompositionError if any molar abundance is negative.
*
* @par Example:
* @code
@@ -475,7 +475,7 @@ namespace fourdst::composition {
*
* @throws exceptions::UnknownSymbolError if any symbol is not in the atomic species database.
* @throws exceptions::UnregisteredSymbolError if any symbol is not in the composition.
* @throws exceptions::InvalidAbundanceError if any molar abundance is negative.
* @throws exceptions::InvalidCompositionError if any molar abundance is negative.
*
* @par Example:
* @code
@@ -495,7 +495,7 @@ namespace fourdst::composition {
* @param molar_abundances The molar abundances to set.
*
* @throws exceptions::UnregisteredSymbolError if any isotope is not registered in the composition.
* @throws exceptions::InvalidAbundanceError if any molar abundance is negative.
* @throws exceptions::InvalidCompositionError if any molar abundance is negative.
*
* @par Example:
* @code