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

docs(opatio-docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-16 12:47:17 -05:00
parent 0d5406aeee
commit 11b3811382
43 changed files with 583 additions and 344 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/latex/files.tex
View File

@@ -1,16 +1,26 @@
\doxysection{File List}
Here is a list of all documented files with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{src/const/public/{\bfseries const.\+h} }{\pageref{const_8h}}{}
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
\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}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{LockableDObject_8cpp}{Lockable\+DObject.\+cpp}} }{\pageref{LockableDObject_8cpp}}{}
\item\contentsline{section}{src/dobj/private/\mbox{\hyperlink{Metadata_8cpp}{Metadata.\+cpp}} \\*Implementation of the \mbox{\hyperlink{classMetadata}{Metadata}} class used in the dobj module }{\pageref{Metadata_8cpp}}{}
\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/opac/public/{\bfseries opac.\+h} }{\pageref{opac_8h}}{}
\item\contentsline{section}{src/opat\+IO/public/{\bfseries opat\+IO.\+h} }{\pageref{opatIO_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}{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/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}}{}
\item\contentsline{section}{utils/opatio/build/lib/opatio/opat/\mbox{\hyperlink{build_2lib_2opatio_2opat_2opat_8py}{opat.\+py}} }{\pageref{build_2lib_2opatio_2opat_2opat_8py}}{}
\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}}{}
\end{DoxyCompactList}

18
docs/latex/refman.tex
View File

@@ -171,6 +171,10 @@
\hypersetup{pageanchor=true}
%--- Begin generated contents ---
\chapter{opat\+IO python module}
\label{md_utils_opatio_readme}
\Hypertarget{md_utils_opatio_readme}
\input{md_utils_opatio_readme}
\chapter{Test List}
\label{test}
\Hypertarget{test}
@@ -197,16 +201,30 @@
\input{structOPATTable}
\input{structTableIndex}
\chapter{File Documentation}
\input{const_8cpp}
\input{const_8h}
\input{DObject_8cpp}
\input{LockableDObject_8cpp}
\input{Metadata_8cpp}
\input{DObject_8h}
\input{LockableDObject_8h}
\input{Metadata_8h}
\input{opac_8h}
\input{opatIO_8cpp}
\input{opatIO_8h}
\input{constTest_8cpp}
\input{DObjectTest_8cpp}
\input{LockableDObjectTest_8cpp}
\input{MetadataTest_8cpp}
\input{testDObject_8cpp}
\input{opatIOTest_8cpp}
\input{build_2lib_2opatio_2____init_____8py}
\input{build_2lib_2opatio_2opat_2____init_____8py}
\input{src_2opatio_2____init_____8py}
\input{src_2opatio_2opat_2____init_____8py}
\input{build_2lib_2opatio_2opat_2opat_8py}
\input{src_2opatio_2opat_2opat_8py}
\input{readme_8md}
%--- End generated contents ---
% Index