docs(Doxyfile,docs): added doxygen config and initial built doc
This commit is contained in:
43
docs/latex/_metadata_8cpp.tex
Normal file
43
docs/latex/_metadata_8cpp.tex
Normal file
@@ -0,0 +1,43 @@
|
||||
\doxysection{src/dobj/private/\+Metadata.cpp File Reference}
|
||||
\hypertarget{_metadata_8cpp}{}\label{_metadata_8cpp}\index{src/dobj/private/Metadata.cpp@{src/dobj/private/Metadata.cpp}}
|
||||
|
||||
|
||||
Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
|
||||
{\ttfamily \#include "{}Metadata.\+h"{}}\newline
|
||||
\doxysubsubsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
std\+::ostream \& \mbox{\hyperlink{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}{operator$<$$<$}} (std\+::ostream \&os, const \mbox{\hyperlink{class_metadata}{Metadata}} \&metadata)
|
||||
\begin{DoxyCompactList}\small\item\em Prints the metadata information for debugging purposes. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Implementation of the \doxylink{class_metadata}{Metadata} class used in the dobj module.
|
||||
|
||||
Provides methods to manage metadata for data objects, including size, type, dimensions, and debugging flags.
|
||||
|
||||
\doxysubsection{Function Documentation}
|
||||
\Hypertarget{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}\index{Metadata.cpp@{Metadata.cpp}!operator$<$$<$@{operator$<$$<$}}
|
||||
\index{operator$<$$<$@{operator$<$$<$}!Metadata.cpp@{Metadata.cpp}}
|
||||
\doxysubsubsection{\texorpdfstring{operator$<$$<$()}{operator<<()}}
|
||||
{\footnotesize\ttfamily \label{_metadata_8cpp_a12949a1ea26c4ff1afeb97101c0493c5}
|
||||
std\+::ostream \& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{os}{, }\item[{const \mbox{\hyperlink{class_metadata}{Metadata}} \&}]{metadata}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Prints the metadata information for debugging purposes.
|
||||
|
||||
This function provides a human-\/readable summary of the metadata. Useful for quick checks or logging during debugging sessions.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em os} & The output stream to print to. \\
|
||||
\hline
|
||||
{\em metadata} & The \doxylink{class_metadata}{Metadata} object to print. \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the output stream.
|
||||
\end{DoxyReturn}
|
||||
Reference in New Issue
Block a user