docs(Doxyfile,docs): added doxygen config and initial built doc
This commit is contained in:
50
docs/latex/class_lockable_d_object.tex
Normal file
50
docs/latex/class_lockable_d_object.tex
Normal file
@@ -0,0 +1,50 @@
|
||||
\doxysection{Lockable\+DObject Class Reference}
|
||||
\hypertarget{class_lockable_d_object}{}\label{class_lockable_d_object}\index{LockableDObject@{LockableDObject}}
|
||||
|
||||
|
||||
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$Lockable\+DObject.\+h$>$}
|
||||
|
||||
\doxysubsubsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
\Hypertarget{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}\label{class_lockable_d_object_ae1a174a2740fa053626fe2820ee0efee}
|
||||
{\bfseries Lockable\+DObject} ()=default
|
||||
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item
|
||||
\mbox{\hyperlink{class_d_object}{DObject}} \& \mbox{\hyperlink{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}{get}} ()
|
||||
\begin{DoxyCompactList}\small\item\em Access the underlying \doxylink{class_d_object}{DObject}. \end{DoxyCompactList}\item
|
||||
\Hypertarget{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}\label{class_lockable_d_object_ade38ca54703913359fc3b4366f6e292a}
|
||||
void {\bfseries lock} ()
|
||||
\begin{DoxyCompactList}\small\item\em Locks the mutex to ensure thread-\/safe access. \end{DoxyCompactList}\item
|
||||
\Hypertarget{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}\label{class_lockable_d_object_a1481ed99dcd837490bf28309aadaedfb}
|
||||
void {\bfseries unlock} ()
|
||||
\begin{DoxyCompactList}\small\item\em Unlocks the mutex after thread-\/safe access. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\doxysubsection{Detailed Description}
|
||||
Wrapper for \doxylink{class_d_object}{DObject} with thread-\/safe access.
|
||||
|
||||
\doxysubsection{Member Function Documentation}
|
||||
\Hypertarget{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}\index{LockableDObject@{LockableDObject}!get@{get}}
|
||||
\index{get@{get}!LockableDObject@{LockableDObject}}
|
||||
\doxysubsubsection{\texorpdfstring{get()}{get()}}
|
||||
{\footnotesize\ttfamily \label{class_lockable_d_object_adcfe201fc728cc1c6fcf638a566ba9a1}
|
||||
\mbox{\hyperlink{class_d_object}{DObject}} \& Lockable\+DObject\+::get (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Access the underlying \doxylink{class_d_object}{DObject}.
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
A reference to the wrapped \doxylink{class_d_object}{DObject}.
|
||||
\end{DoxyReturn}
|
||||
|
||||
|
||||
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/dobj/public/\mbox{\hyperlink{_lockable_d_object_8h}{Lockable\+DObject.\+h}}\item
|
||||
src/dobj/private/Lockable\+DObject.\+cpp\end{DoxyCompactItemize}
|
||||
Reference in New Issue
Block a user