detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-23 11:57:58 +02:00
Code Issues Actions Packages Releases Activity

setup doxygen and clang-uml files

Browse Source
This commit is contained in:
Bechir Braham
2024-04-11 17:20:34 +02:00
parent 111b421476
commit 2ebbd0d7cd
640 changed files with 77235 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/latex/classaare_1_1Frame_1_1Frame.tex Normal file
View File

@ -0,0 +1,54 @@
\doxysection{aare.\+Frame.\+Frame Class Reference}
\hypertarget{classaare_1_1Frame_1_1Frame}{}\label{classaare_1_1Frame_1_1Frame}\index{aare.Frame.Frame@{aare.Frame.Frame}}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classaare_1_1Frame_1_1Frame_a858e2b6682c920029d30c18ab966f1e5}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, frame\+Impl)
\item
Any \mbox{\hyperlink{classaare_1_1Frame_1_1Frame_a18a261b317ce022ec705de3f20a7cb1a}{\+\_\+\+\_\+getattribute\+\_\+\+\_\+}} (self, str \+\_\+\+\_\+name)
\end{DoxyCompactItemize}
\doxysubsubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classaare_1_1Frame_1_1Frame_ac3fc00fff0659d2362358fc6d31f1920}{\+\_\+frame\+Impl}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\begin{DoxyVerb}Frame class. uses proxy pattern to wrap around the pybinding class
the intention behind it is to only use one class for frames in python (not Frame_8, Frame_16, etc)
\end{DoxyVerb}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classaare_1_1Frame_1_1Frame_a858e2b6682c920029d30c18ab966f1e5}\label{classaare_1_1Frame_1_1Frame_a858e2b6682c920029d30c18ab966f1e5}
\index{aare.Frame.Frame@{aare.Frame.Frame}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!aare.Frame.Frame@{aare.Frame.Frame}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily aare.\+Frame.\+Frame.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{frame\+Impl }\end{DoxyParamCaption})}
\doxysubsection{Member Function Documentation}
\Hypertarget{classaare_1_1Frame_1_1Frame_a18a261b317ce022ec705de3f20a7cb1a}\label{classaare_1_1Frame_1_1Frame_a18a261b317ce022ec705de3f20a7cb1a}
\index{aare.Frame.Frame@{aare.Frame.Frame}!\_\_getattribute\_\_@{\_\_getattribute\_\_}}
\index{\_\_getattribute\_\_@{\_\_getattribute\_\_}!aare.Frame.Frame@{aare.Frame.Frame}}
\doxysubsubsection{\texorpdfstring{\_\_getattribute\_\_()}{\_\_getattribute\_\_()}}
{\footnotesize\ttfamily Any aare.\+Frame.\+Frame.\+\_\+\+\_\+getattribute\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{str}]{\+\_\+\+\_\+name }\end{DoxyParamCaption})}
\begin{DoxyVerb}Proxy pattern to call the methods of the frameImpl
\end{DoxyVerb}
\doxysubsection{Field Documentation}
\Hypertarget{classaare_1_1Frame_1_1Frame_ac3fc00fff0659d2362358fc6d31f1920}\label{classaare_1_1Frame_1_1Frame_ac3fc00fff0659d2362358fc6d31f1920}
\index{aare.Frame.Frame@{aare.Frame.Frame}!\_frameImpl@{\_frameImpl}}
\index{\_frameImpl@{\_frameImpl}!aare.Frame.Frame@{aare.Frame.Frame}}
\doxysubsubsection{\texorpdfstring{\_frameImpl}{\_frameImpl}}
{\footnotesize\ttfamily aare.\+Frame.\+Frame.\+\_\+frame\+Impl\hspace{0.3cm}{\ttfamily [protected]}}
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
python/aare/\mbox{\hyperlink{Frame_8py}{Frame.\+py}}\end{DoxyCompactItemize}