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

docs(docs): added robust docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-24 09:35:52 -04:00
parent 1905e642ab
commit 9f5ef7fd6a
452 changed files with 578689 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/latex/exceptions__composition_8h.tex Normal file
View File

@@ -0,0 +1,38 @@
\doxysection{src/composition/include/fourdst/composition/exceptions/exceptions\+\_\+composition.h File Reference}
\hypertarget{exceptions__composition_8h}{}\label{exceptions__composition_8h}\index{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h@{src/composition/include/fourdst/composition/exceptions/exceptions\_composition.h}}
{\ttfamily \#include $<$exception$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Error}}
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to composition objects. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_entry_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Entry\+Error}}
\begin{DoxyCompactList}\small\item\em Base class for exceptions related to individual entries within a composition. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_not_finalized_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Not\+Finalized\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when an operation is attempted on a composition that has not been finalized. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_composition_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Composition\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when a composition is in an invalid or inconsistent state. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_mixing_mode}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Mixing\+Mode}}
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid or unsupported mixing mode. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Symbol\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol used in a composition is invalid. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_unregistered_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Unregistered\+Symbol\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when a symbol is used that has not been registered. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_failed_to_finalize_composition_error}{fourdst\+::composition\+::exceptions\+::\+Failed\+To\+Finalize\+Composition\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when the finalization process of a composition fails. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_invalid_species_symbol_error}{fourdst\+::composition\+::exceptions\+::\+Invalid\+Species\+Symbol\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown for an invalid chemical species symbol in a composition entry. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_entry_already_initialized_error}{fourdst\+::composition\+::exceptions\+::\+Entry\+Already\+Initialized\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown when attempting to initialize a composition entry that has already been initialized. \end{DoxyCompactList}\item
class \mbox{\hyperlink{classfourdst_1_1composition_1_1exceptions_1_1_composition_mode_error}{fourdst\+::composition\+::exceptions\+::\+Composition\+Mode\+Error}}
\begin{DoxyCompactList}\small\item\em Exception thrown due to a conflict in composition modes at the entry level. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespacefourdst}{fourdst}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition}{fourdst\+::composition}}
\item
namespace \mbox{\hyperlink{namespacefourdst_1_1composition_1_1exceptions}{fourdst\+::composition\+::exceptions}}
\end{DoxyCompactItemize}