mirror of
https://github.com/slsdetectorgroup/aare.git
synced 2025-06-23 03:57:57 +02:00
setup doxygen and clang-uml files
This commit is contained in:
Bechir Braham
364
docs/latex/refman.tex
Normal file
364
docs/latex/refman.tex
Normal file
@ -0,0 +1,364 @@
|
||||
% Handle batch mode
|
||||
% to overcome problems with too many open files
|
||||
\let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
|
||||
\pdfminorversion=7
|
||||
% Set document class depending on configuration
|
||||
\documentclass[twoside]{book}
|
||||
%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
|
||||
\usepackage{ifthen}
|
||||
\ifx\requestedLaTeXdate\undefined
|
||||
\usepackage{array}
|
||||
\else
|
||||
\usepackage{array}[=2016-10-06]
|
||||
\fi
|
||||
%%
|
||||
% Packages required by doxygen
|
||||
\makeatletter
|
||||
\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}
|
||||
% suppress package identification of infwarerr as it contains the word "warning"
|
||||
\let\@@protected@wlog\protected@wlog
|
||||
\def\protected@wlog#1{\wlog{package info suppressed}}
|
||||
\RequirePackage{infwarerr}
|
||||
\let\protected@wlog\@@protected@wlog
|
||||
\makeatother
|
||||
\IfFormatAtLeastTF{2016/01/01}{}{\usepackage{fixltx2e}} % for \textsubscript
|
||||
\IfFormatAtLeastTF{2015/01/01}{\pdfsuppresswarningpagegroup=1}{}
|
||||
\usepackage{doxygen}
|
||||
\usepackage{graphicx}
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{makeidx}
|
||||
\PassOptionsToPackage{warn}{textcomp}
|
||||
\usepackage{textcomp}
|
||||
\usepackage[nointegrals]{wasysym}
|
||||
\usepackage{ifxetex}
|
||||
% NLS support packages
|
||||
% Define default fonts
|
||||
% Font selection
|
||||
\usepackage[T1]{fontenc}
|
||||
% set main and monospaced font
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\doxyallsectionsfont{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\renewcommand{\DoxyLabelFont}{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
||||
% Arguments of doxygenemoji:
|
||||
% 1) ':<text>:' form of the emoji, already LaTeX-escaped
|
||||
% 2) file with the name of the emoji without the .png extension
|
||||
% in case image exist use this otherwise use the ':<text>:' form
|
||||
\newcommand{\doxygenemoji}[2]{%
|
||||
\IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
|
||||
}
|
||||
% Page & text layout
|
||||
\usepackage{geometry}
|
||||
\geometry{%
|
||||
a4paper,%
|
||||
top=2.5cm,%
|
||||
bottom=2.5cm,%
|
||||
left=2.5cm,%
|
||||
right=2.5cm%
|
||||
}
|
||||
\usepackage{changepage}
|
||||
% Allow a bit of overflow to go unnoticed by other means
|
||||
\tolerance=750
|
||||
\hfuzz=15pt
|
||||
\hbadness=750
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\setlength{\parindent}{0cm}
|
||||
\newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
|
||||
\newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
|
||||
\doxynormalparskip
|
||||
% Redefine paragraph/subparagraph environments, using sectsty fonts
|
||||
\makeatletter
|
||||
\renewcommand{\paragraph}{%
|
||||
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@parafont%
|
||||
}%
|
||||
}
|
||||
\renewcommand{\subparagraph}{%
|
||||
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@subparafont%
|
||||
}%
|
||||
}
|
||||
\makeatother
|
||||
\makeatletter
|
||||
\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
|
||||
\makeatother
|
||||
% Headers & footers
|
||||
\usepackage{fancyhdr}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\fancypagestyle{fancyplain}{
|
||||
\fancyhf{}
|
||||
\fancyhead[LE, RO]{\bfseries\thepage}
|
||||
\fancyhead[LO]{\bfseries\rightmark}
|
||||
\fancyhead[RE]{\bfseries\leftmark}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
}
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[LO, RE]{\bfseries\scriptsize Generated by Doxygen }
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
}
|
||||
\pagestyle{fancyplain}
|
||||
\renewcommand{\chaptermark}[1]{%
|
||||
\markboth{#1}{}%
|
||||
}
|
||||
\renewcommand{\sectionmark}[1]{%
|
||||
\markright{\thesection\ #1}%
|
||||
}
|
||||
% ToC, LoF, LoT, bibliography, and index
|
||||
% Indices & bibliography
|
||||
\usepackage{natbib}
|
||||
\usepackage[titles]{tocloft}
|
||||
\setcounter{tocdepth}{3}
|
||||
\setcounter{secnumdepth}{5}
|
||||
% creating indexes
|
||||
\makeindex
|
||||
\usepackage{newunicodechar}
|
||||
\makeatletter
|
||||
\def\doxynewunicodechar#1#2{%
|
||||
\@tempswafalse
|
||||
\edef\nuc@tempa{\detokenize{#1}}%
|
||||
\if\relax\nuc@tempa\relax
|
||||
\nuc@emptyargerr
|
||||
\else
|
||||
\edef\@tempb{\expandafter\@car\nuc@tempa\@nil}%
|
||||
\nuc@check
|
||||
\if@tempswa
|
||||
\@namedef{u8:\nuc@tempa}{#2}%
|
||||
\fi
|
||||
\fi
|
||||
}
|
||||
\makeatother
|
||||
\doxynewunicodechar{⁻}{${}^{-}$}% Superscript minus
|
||||
\doxynewunicodechar{²}{${}^{2}$}% Superscript two
|
||||
\doxynewunicodechar{³}{${}^{3}$}% Superscript three
|
||||
% Hyperlinks
|
||||
% Hyperlinks (required, but should be loaded last)
|
||||
\ifpdf
|
||||
\usepackage[pdftex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\ifxetex
|
||||
\usepackage[pagebackref=true]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
||||
\fi
|
||||
\fi
|
||||
\hypersetup{%
|
||||
colorlinks=true,%
|
||||
linkcolor=blue,%
|
||||
citecolor=blue,%
|
||||
unicode,%
|
||||
pdftitle={AARE},%
|
||||
pdfsubject={Data analysis library for PSI hybrid detectors}%
|
||||
}
|
||||
% Custom commands used by the header
|
||||
% Custom commands
|
||||
\newcommand{\clearemptydoublepage}{%
|
||||
\newpage{\pagestyle{empty}\cleardoublepage}%
|
||||
}
|
||||
% caption style definition
|
||||
\usepackage{caption}
|
||||
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
||||
% in page table of contents
|
||||
\IfFormatAtLeastTF{2023/05/01}{\usepackage[deeplevels]{etoc}}{\usepackage[deeplevels]{etoc_doxygen}}
|
||||
\etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
|
||||
\etocsetlevel{subsubsubsection}{4}
|
||||
\etocsetlevel{subsubsubsubsection}{5}
|
||||
\etocsetlevel{subsubsubsubsubsection}{6}
|
||||
\etocsetlevel{subsubsubsubsubsubsection}{7}
|
||||
\etocsetlevel{paragraph}{8}
|
||||
\etocsetlevel{subparagraph}{9}
|
||||
% prevent numbers overlap the titles in toc
|
||||
\renewcommand{\numberline}[1]{#1~}
|
||||
% End of preamble, now comes the document contents
|
||||
%===== C O N T E N T S =====
|
||||
\begin{document}
|
||||
\raggedbottom
|
||||
% Titlepage & ToC
|
||||
% To avoid duplicate page anchors due to reuse of same numbers for
|
||||
% the index (be it as roman numbers)
|
||||
\hypersetup{pageanchor=false,
|
||||
bookmarksnumbered=true,
|
||||
pdfencoding=unicode
|
||||
}
|
||||
\pagenumbering{alph}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large AARE}\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.9.7}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{arabic}
|
||||
% re-enable anchors again
|
||||
\hypersetup{pageanchor=true}
|
||||
%--- Begin generated contents ---
|
||||
\input{index}
|
||||
\chapter{Namespace Index}
|
||||
\input{namespaces}
|
||||
\chapter{Hierarchical Index}
|
||||
\input{hierarchy}
|
||||
\chapter{Data Structure Index}
|
||||
\input{annotated}
|
||||
\chapter{File Index}
|
||||
\input{files}
|
||||
\chapter{Namespace Documentation}
|
||||
\input{namespaceaare}
|
||||
\input{namespaceaare_1_1File}
|
||||
\input{namespaceaare_1_1Frame}
|
||||
\input{namespaceaare_1_1logger}
|
||||
\input{namespaceaare_1_1logger_1_1internal}
|
||||
\input{namespaceaare_1_1network__io}
|
||||
\input{namespaceaare_1_1NumpyHelpers}
|
||||
\input{namespaceexample}
|
||||
\input{namespaceexample_1_1read__frame}
|
||||
\input{namespacefolly}
|
||||
\input{namespaceread__first__frame__number}
|
||||
\input{namespaceread__frame}
|
||||
\input{namespaceread__multiport}
|
||||
\input{namespacesimdjson}
|
||||
\input{namespacewrite__test__files}
|
||||
\chapter{Data Structure Documentation}
|
||||
\input{classaare_1_1CircularFifo}
|
||||
\input{classaare_1_1ClusterFinder}
|
||||
\input{classaare_1_1DType}
|
||||
\input{classaare_1_1File}
|
||||
\input{classaare_1_1File_1_1File}
|
||||
\input{structaare_1_1FileConfig}
|
||||
\input{classaare_1_1FileInterface}
|
||||
\input{classaare_1_1Frame}
|
||||
\input{classaare_1_1Frame_1_1Frame}
|
||||
\input{structaare_1_1ClusterFinder_1_1Hit}
|
||||
\input{classaare_1_1logger_1_1Logger}
|
||||
\input{structMoveOnlyInt}
|
||||
\input{classaare_1_1NDArray}
|
||||
\input{classaare_1_1NDView}
|
||||
\input{classaare_1_1network__io_1_1NetworkError}
|
||||
\input{classaare_1_1NumpyFile}
|
||||
\input{structaare_1_1NumpyHeader}
|
||||
\input{structfolly_1_1ProducerConsumerQueue}
|
||||
\input{classaare_1_1RawFile}
|
||||
\input{structaare_1_1RawFileConfig}
|
||||
\input{structaare_1_1sls__detector__header}
|
||||
\input{classaare_1_1SubFile}
|
||||
\input{structaare_1_1xy}
|
||||
\input{structaare_1_1ZmqFrame}
|
||||
\input{structaare_1_1ZmqHeader}
|
||||
\input{classaare_1_1ZmqSocket}
|
||||
\input{classaare_1_1ZmqSocketReceiver}
|
||||
\input{classaare_1_1ZmqSocketSender}
|
||||
\chapter{File Documentation}
|
||||
\input{CircularFifo_8hpp}
|
||||
\input{CircularFifo_8hpp_source}
|
||||
\input{core_2include_2aare_2core_2defs_8hpp}
|
||||
\input{core_2include_2aare_2core_2defs_8hpp_source}
|
||||
\input{network__io_2include_2aare_2network__io_2defs_8hpp}
|
||||
\input{network__io_2include_2aare_2network__io_2defs_8hpp_source}
|
||||
\input{DType_8hpp}
|
||||
\input{DType_8hpp_source}
|
||||
\input{Frame_8hpp}
|
||||
\input{Frame_8hpp_source}
|
||||
\input{NDArray_8hpp}
|
||||
\input{NDArray_8hpp_source}
|
||||
\input{NDView_8hpp}
|
||||
\input{NDView_8hpp_source}
|
||||
\input{ProducerConsumerQueue_8hpp}
|
||||
\input{ProducerConsumerQueue_8hpp_source}
|
||||
\input{VariableSizeClusterFinder_8hpp}
|
||||
\input{VariableSizeClusterFinder_8hpp_source}
|
||||
\input{defs_8cpp}
|
||||
\input{DType_8cpp}
|
||||
\input{Frame_8cpp}
|
||||
\input{CircularFifo_8test_8cpp}
|
||||
\input{defs_8test_8cpp}
|
||||
\input{DType_8test_8cpp}
|
||||
\input{Frame_8test_8cpp}
|
||||
\input{NDArray_8test_8cpp}
|
||||
\input{NDView_8test_8cpp}
|
||||
\input{ProducerConsumerQueue_8test_8cpp}
|
||||
\input{wrappers_8test_8cpp}
|
||||
\input{data_2jungfrau_2read__frame_8py}
|
||||
\input{python_2example_2read__frame_8py}
|
||||
\input{write__test__files_8py}
|
||||
\input{read__first__frame__number_8py}
|
||||
\input{jungfrau_2read__multiport_8py}
|
||||
\input{scripts_2read__multiport_8py}
|
||||
\input{json__example_8cpp}
|
||||
\input{logger__example_8cpp}
|
||||
\input{multiport__example_8cpp}
|
||||
\input{mythen__example_8cpp}
|
||||
\input{numpy__read__example_8cpp}
|
||||
\input{numpy__write__example_8cpp}
|
||||
\input{raw__example_8cpp}
|
||||
\input{zmq__receiver__example_8cpp}
|
||||
\input{zmq__restream__example_8cpp}
|
||||
\input{zmq__sender__example_8cpp}
|
||||
\input{File_8hpp}
|
||||
\input{File_8hpp_source}
|
||||
\input{FileInterface_8hpp}
|
||||
\input{FileInterface_8hpp_source}
|
||||
\input{NumpyFile_8hpp}
|
||||
\input{NumpyFile_8hpp_source}
|
||||
\input{NumpyHelpers_8hpp}
|
||||
\input{NumpyHelpers_8hpp_source}
|
||||
\input{RawFile_8hpp}
|
||||
\input{RawFile_8hpp_source}
|
||||
\input{SubFile_8hpp}
|
||||
\input{SubFile_8hpp_source}
|
||||
\input{File_8cpp}
|
||||
\input{NumpyFile_8cpp}
|
||||
\input{NumpyHelpers_8cpp}
|
||||
\input{RawFile_8cpp}
|
||||
\input{SubFile_8cpp}
|
||||
\input{NumpyFile_8test_8cpp}
|
||||
\input{NumpyHelpers_8test_8cpp}
|
||||
\input{RawFile_8test_8cpp}
|
||||
\input{aare_8hpp}
|
||||
\input{aare_8hpp_source}
|
||||
\input{ZmqHeader_8hpp}
|
||||
\input{ZmqHeader_8hpp_source}
|
||||
\input{ZmqSocket_8hpp}
|
||||
\input{ZmqSocket_8hpp_source}
|
||||
\input{ZmqSocketReceiver_8hpp}
|
||||
\input{ZmqSocketReceiver_8hpp_source}
|
||||
\input{ZmqSocketSender_8hpp}
|
||||
\input{ZmqSocketSender_8hpp_source}
|
||||
\input{ZmqHeader_8cpp}
|
||||
\input{ZmqSocket_8cpp}
|
||||
\input{ZmqSocketReceiver_8cpp}
|
||||
\input{ZmqSocketSender_8cpp}
|
||||
\input{ZmqHeader_8test_8cpp}
|
||||
\input{File_8py}
|
||||
\input{Frame_8py}
|
||||
\input{aare_2____init_____8py}
|
||||
\input{example_2____init_____8py}
|
||||
\input{bindings_8cpp}
|
||||
\input{README_8md}
|
||||
\input{test_8cpp}
|
||||
\input{logger_8hpp}
|
||||
\input{logger_8hpp_source}
|
||||
\input{logger_8cpp}
|
||||
\input{logger_8test_8cpp}
|
||||
%--- End generated contents ---
|
||||
% Index
|
||||
\backmatter
|
||||
\newpage
|
||||
\phantomsection
|
||||
\clearemptydoublepage
|
||||
\addcontentsline{toc}{chapter}{\indexname}
|
||||
\printindex
|
||||
% Required for some languages (in combination with latexdocumentpre from the header)
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user