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

docs(opatIO): wrote and built doxygen docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-02-16 12:29:51 -05:00
parent 5ce365d545
commit 0d5406aeee
44 changed files with 711 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/latex/annotated.tex
View File

@@ -1,13 +1,17 @@
\doxysection{Class List}
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{classCell}{Cell}} }{\pageref{classCell}}{}
\item\contentsline{section}{\mbox{\hyperlink{structconstant}{constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{structconstant}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconstants}{constants}} \\*Class to manage a collection of constants }{\pageref{classconstants}}{}
\item\contentsline{section}{\mbox{\hyperlink{structConstant}{Constant}} \\*Structure to hold a constant\textquotesingle{}s details }{\pageref{structConstant}}{}
\item\contentsline{section}{\mbox{\hyperlink{classConstants}{Constants}} \\*Class to manage a collection of constants }{\pageref{classConstants}}{}
\item\contentsline{section}{\mbox{\hyperlink{classconstTest}{const\+Test}} \\*Test suite for the const class }{\pageref{classconstTest}}{}
\item\contentsline{section}{\mbox{\hyperlink{classDObject}{DObject}} \\*A universal data container class }{\pageref{classDObject}}{}
\item\contentsline{section}{\mbox{\hyperlink{classDObjectTest}{DObject\+Test}} \\*Test suite for the \mbox{\hyperlink{classDObject}{DObject}} class }{\pageref{classDObjectTest}}{}
\item\contentsline{section}{\mbox{\hyperlink{structHeader}{Header}} \\*Structure to hold the header information of an OPAT file }{\pageref{structHeader}}{}
\item\contentsline{section}{\mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} \\*Wrapper for \mbox{\hyperlink{classDObject}{DObject}} with thread-\/safe access }{\pageref{classLockableDObject}}{}
\item\contentsline{section}{\mbox{\hyperlink{classLockableDObjectTest}{Lockable\+DObject\+Test}} \\*Test suite for the \mbox{\hyperlink{classLockableDObject}{Lockable\+DObject}} class }{\pageref{classLockableDObjectTest}}{}
\item\contentsline{section}{\mbox{\hyperlink{classMetadata}{Metadata}} \\*Represents metadata information for data objects in the dobj module }{\pageref{classMetadata}}{}
\item\contentsline{section}{\mbox{\hyperlink{classMetadataTest}{Metadata\+Test}} \\*Test suite for the \mbox{\hyperlink{classMetadata}{Metadata}} class }{\pageref{classMetadataTest}}{}
\item\contentsline{section}{\mbox{\hyperlink{classOpatIO}{Opat\+IO}} \\*Class to manage the input/output operations for OPAT files }{\pageref{classOpatIO}}{}
\item\contentsline{section}{\mbox{\hyperlink{classopatIOTest}{opat\+IOTest}} \\*Test suite for the const class }{\pageref{classopatIOTest}}{}
\item\contentsline{section}{\mbox{\hyperlink{structOPATTable}{OPATTable}} \\*Structure to hold the data of an OPAT table }{\pageref{structOPATTable}}{}
\item\contentsline{section}{\mbox{\hyperlink{structTableIndex}{Table\+Index}} \\*Structure to hold the index information of a table in an OPAT file }{\pageref{structTableIndex}}{}
\end{DoxyCompactList}

5
docs/latex/files.tex
View File

@@ -6,12 +6,11 @@ Here is a list of all documented files with brief descriptions\+:\begin{DoxyComp
\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/mapping/private/{\bfseries grid.\+h} }{\pageref{grid_8h}}{}
\item\contentsline{section}{src/mapping/private/{\bfseries mapper.\+h} }{\pageref{mapper_8h}}{}
\item\contentsline{section}{src/mesh/public/{\bfseries mesh.\+h} }{\pageref{mesh_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}{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/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}}{}
\end{DoxyCompactList}

11
docs/latex/refman.tex
View File

@@ -182,16 +182,20 @@
\chapter{File Index}
\input{files}
\chapter{Class Documentation}
\input{classCell}
\input{structconstant}
\input{classconstants}
\input{structConstant}
\input{classConstants}
\input{classconstTest}
\input{classDObject}
\input{classDObjectTest}
\input{structHeader}
\input{classLockableDObject}
\input{classLockableDObjectTest}
\input{classMetadata}
\input{classMetadataTest}
\input{classOpatIO}
\input{classopatIOTest}
\input{structOPATTable}
\input{structTableIndex}
\chapter{File Documentation}
\input{DObject_8cpp}
\input{Metadata_8cpp}
@@ -202,6 +206,7 @@
\input{DObjectTest_8cpp}
\input{LockableDObjectTest_8cpp}
\input{MetadataTest_8cpp}
\input{opatIOTest_8cpp}
%--- End generated contents ---
% Index