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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-19 16:24:41 -05:00
parent fac54201ff
commit 47b833e0d2
43 changed files with 751 additions and 429 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/latex/files.tex
View File

@@ -1,5 +1,7 @@
\doxysection{File List}
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/config/private/\mbox{\hyperlink{config_8cpp}{config.\+cpp}} }{\pageref{config_8cpp}}{}
\item\contentsline{section}{src/config/public/\mbox{\hyperlink{config_8h}{config.\+h}} }{\pageref{config_8h}}{}
\item\contentsline{section}{src/const/private/\mbox{\hyperlink{const_8cpp}{const.\+cpp}} }{\pageref{const_8cpp}}{}
\item\contentsline{section}{src/const/public/\mbox{\hyperlink{const_8h}{const.\+h}} }{\pageref{const_8h}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{DObject_8cpp}{DObject.\+cpp}} \\*Implementation of the \mbox{\hyperlink{classDObject}{DObject}} class }{\pageref{DObject_8cpp}}{}
@@ -8,14 +10,24 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{DObject_8h}{DObject.\+h}} \\*Defines the \mbox{\hyperlink{classDObject}{DObject}} class, a universal data container for the project }{\pageref{DObject_8h}}{}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{LockableDObject_8h}{Lockable\+DObject.\+h}} \\*A lightweight wrapper for \mbox{\hyperlink{classDObject}{DObject}} that adds locking capabilities }{\pageref{LockableDObject_8h}}{}
\item\contentsline{section}{src/dobj/public/\mbox{\hyperlink{Metadata_8h}{Metadata.\+h}} \\*Public interface for the \mbox{\hyperlink{classMetadata}{Metadata}} class used in the dobj module }{\pageref{Metadata_8h}}{}
\item\contentsline{section}{src/mesh\+IO/private/\mbox{\hyperlink{meshIO_8cpp}{mesh\+IO.\+cpp}} }{\pageref{meshIO_8cpp}}{}
\item\contentsline{section}{src/mesh\+IO/public/\mbox{\hyperlink{meshIO_8h}{mesh\+IO.\+h}} }{\pageref{meshIO_8h}}{}
\item\contentsline{section}{src/opac/public/\mbox{\hyperlink{opac_8h}{opac.\+h}} }{\pageref{opac_8h}}{}
\item\contentsline{section}{src/opat\+IO/private/\mbox{\hyperlink{opatIO_8cpp}{opat\+IO.\+cpp}} }{\pageref{opatIO_8cpp}}{}
\item\contentsline{section}{src/opat\+IO/public/\mbox{\hyperlink{opatIO_8h}{opat\+IO.\+h}} }{\pageref{opatIO_8h}}{}
\item\contentsline{section}{src/poly/coeff/private/\mbox{\hyperlink{polyCoeff_8cpp}{poly\+Coeff.\+cpp}} }{\pageref{polyCoeff_8cpp}}{}
\item\contentsline{section}{src/poly/coeff/public/\mbox{\hyperlink{polyCoeff_8h}{poly\+Coeff.\+h}} }{\pageref{polyCoeff_8h}}{}
\item\contentsline{section}{src/poly/utils/private/\mbox{\hyperlink{polyIO_8cpp}{poly\+IO.\+cpp}} }{\pageref{polyIO_8cpp}}{}
\item\contentsline{section}{src/poly/utils/private/\mbox{\hyperlink{polyMFEMUtils_8cpp}{poly\+MFEMUtils.\+cpp}} }{\pageref{polyMFEMUtils_8cpp}}{}
\item\contentsline{section}{src/poly/utils/public/\mbox{\hyperlink{polyIO_8h}{poly\+IO.\+h}} }{\pageref{polyIO_8h}}{}
\item\contentsline{section}{src/poly/utils/public/\mbox{\hyperlink{polyMFEMUtils_8h}{poly\+MFEMUtils.\+h}} }{\pageref{polyMFEMUtils_8h}}{}
\item\contentsline{section}{tests/config/\mbox{\hyperlink{configTest_8cpp}{config\+Test.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classConfig}{Config}} class }{\pageref{configTest_8cpp}}{}
\item\contentsline{section}{tests/const/\mbox{\hyperlink{constTest_8cpp}{const\+Test.\+cpp}} \\*Unit tests for the const class }{\pageref{constTest_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{DObjectTest_8cpp}{DObject\+Test.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classDObject}{DObject}} class }{\pageref{DObjectTest_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{LockableDObjectTest_8cpp}{Lockable\+DObject\+Test.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} class }{\pageref{LockableDObjectTest_8cpp}}{}
\item\contentsline{section}{tests/dobj/\mbox{\hyperlink{MetadataTest_8cpp}{Metadata\+Test.\+cpp}} \\*Unit tests and integration tests for the \mbox{\hyperlink{classMetadata}{Metadata}} class }{\pageref{MetadataTest_8cpp}}{}
\item\contentsline{section}{tests/dobj\+\_\+sandbox/\mbox{\hyperlink{testDObject_8cpp}{test\+DObject.\+cpp}} }{\pageref{testDObject_8cpp}}{}
\item\contentsline{section}{tests/mesh\+IO/\mbox{\hyperlink{meshIOTest_8cpp}{mesh\+IOTest.\+cpp}} }{\pageref{meshIOTest_8cpp}}{}
\item\contentsline{section}{tests/opat\+IO/\mbox{\hyperlink{opatIOTest_8cpp}{opat\+IOTest.\+cpp}} \\*Unit tests for the \mbox{\hyperlink{classOpatIO}{Opat\+IO}} class and associated structs }{\pageref{opatIOTest_8cpp}}{}
\item\contentsline{section}{utils/opatio/build/lib/opatio/\mbox{\hyperlink{build_2lib_2opatio_2____init_____8py}{\+\_\+\+\_\+init\+\_\+\+\_\+.\+py}} }{\pageref{build_2lib_2opatio_2____init_____8py}}{}
\item\contentsline{section}{utils/opatio/build/lib/opatio/opat/\mbox{\hyperlink{build_2lib_2opatio_2opat_2____init_____8py}{\+\_\+\+\_\+init\+\_\+\+\_\+.\+py}} }{\pageref{build_2lib_2opatio_2opat_2____init_____8py}}{}
@@ -23,4 +35,5 @@ Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{utils/opatio/src/opatio/\mbox{\hyperlink{src_2opatio_2____init_____8py}{\+\_\+\+\_\+init\+\_\+\+\_\+.\+py}} }{\pageref{src_2opatio_2____init_____8py}}{}
\item\contentsline{section}{utils/opatio/src/opatio/opat/\mbox{\hyperlink{src_2opatio_2opat_2____init_____8py}{\+\_\+\+\_\+init\+\_\+\+\_\+.\+py}} }{\pageref{src_2opatio_2opat_2____init_____8py}}{}
\item\contentsline{section}{utils/opatio/src/opatio/opat/\mbox{\hyperlink{src_2opatio_2opat_2opat_8py}{opat.\+py}} }{\pageref{src_2opatio_2opat_2opat_8py}}{}
\item\contentsline{section}{utils/opatio/utils/\mbox{\hyperlink{mkTestData_8py}{mk\+Test\+Data.\+py}} }{\pageref{mkTestData_8py}}{}
\end{DoxyCompactList}