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

@@ -1425,7 +1425,7 @@ Sets the molar abundance for a given isotope.
\begin{DoxyExceptions}{Exceptions}
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if the isotope is not registered in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if the molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}
@@ -1467,7 +1467,7 @@ Sets the molar abundances for a set of isotopes.
\begin{DoxyExceptions}{Exceptions}
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if any isotope is not registered in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if any molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if any molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}
@@ -1511,7 +1511,7 @@ Sets the molar abundances for a set of symbols.
\hline
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if any symbol is not in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if any molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if any molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}
@@ -1551,7 +1551,7 @@ Sets the molar abundance for a given symbol.
\hline
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if the symbol is not in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if the molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if the molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}
@@ -1589,7 +1589,7 @@ Sets the molar abundances for a list of isotopes.
\begin{DoxyExceptions}{Exceptions}
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if any isotope is not registered in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if any molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if any molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}
@@ -1632,7 +1632,7 @@ Sets the molar abundances for a list of symbols.
\hline
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{exceptions\+::\+Unregistered\+Symbol\+Error}} & if any symbol is not in the composition. \\
\hline
{\em exceptions\+::\+Invalid\+Abundance\+Error} & if any molar abundance is negative.\\
{\em \doxylink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{exceptions\+::\+Invalid\+Composition\+Error}} & if any molar abundance is negative.\\
\hline
\end{DoxyExceptions}
\begin{DoxyParagraph}{Example\+:}