refman.tex 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. \let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}\documentclass[twoside]{book}
  2. %% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
  3. \usepackage{ifthen}
  4. \ifx\requestedLaTeXdate\undefined
  5. \usepackage{array}
  6. \else
  7. \usepackage{array}[=2016-10-06]
  8. \fi
  9. %%
  10. % Packages required by doxygen
  11. \usepackage{fixltx2e}
  12. \usepackage{calc}
  13. \usepackage{doxygen}
  14. \usepackage{graphicx}
  15. \usepackage[utf8]{inputenc}
  16. \usepackage{makeidx}
  17. \usepackage{multicol}
  18. \usepackage{multirow}
  19. \PassOptionsToPackage{warn}{textcomp}
  20. \usepackage{textcomp}
  21. \usepackage[nointegrals]{wasysym}
  22. \usepackage[table]{xcolor}
  23. \usepackage{ifpdf,ifxetex}
  24. % Font selection
  25. \usepackage[T1]{fontenc}
  26. \usepackage[scaled=.90]{helvet}
  27. \usepackage{courier}
  28. \renewcommand{\familydefault}{\sfdefault}
  29. \usepackage{amssymb}
  30. \usepackage{sectsty}
  31. \allsectionsfont{%
  32. \fontseries{bc}\selectfont%
  33. \color{darkgray}%
  34. }
  35. \renewcommand{\DoxyLabelFont}{%
  36. \fontseries{bc}\selectfont%
  37. \color{darkgray}%
  38. }
  39. \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
  40. % Arguments of doxygenemoji:
  41. % 1) ':<text>:' form of the emoji, already "LaTeX"-escaped
  42. % 2) file with the name of the emoji without the .png extension
  43. % in case image exist use this otherwise use the ':<text>:' form
  44. \newcommand{\doxygenemoji}[2]{%
  45. \IfFileExists{./#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{./#2.png}}}{#1}%
  46. }
  47. % Page & text layout
  48. \usepackage{geometry}
  49. \geometry{%
  50. a4paper,%
  51. top=2.5cm,%
  52. bottom=2.5cm,%
  53. left=2.5cm,%
  54. right=2.5cm%
  55. }
  56. \tolerance=750
  57. \hfuzz=15pt
  58. \hbadness=750
  59. \setlength{\emergencystretch}{15pt}
  60. \setlength{\parindent}{0cm}
  61. \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
  62. \newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
  63. \doxynormalparskip
  64. \makeatletter
  65. \renewcommand{\paragraph}{%
  66. \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
  67. \normalfont\normalsize\bfseries\SS@parafont%
  68. }%
  69. }
  70. \renewcommand{\subparagraph}{%
  71. \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
  72. \normalfont\normalsize\bfseries\SS@subparafont%
  73. }%
  74. }
  75. \makeatother
  76. \makeatletter
  77. \newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
  78. \makeatother
  79. % Headers & footers
  80. \usepackage{fancyhdr}
  81. \pagestyle{fancyplain}
  82. \fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
  83. \fancyhead[CE]{\fancyplain{}{}}
  84. \fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
  85. \fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
  86. \fancyhead[CO]{\fancyplain{}{}}
  87. \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
  88. \fancyfoot[LE]{\fancyplain{}{}}
  89. \fancyfoot[CE]{\fancyplain{}{}}
  90. \fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
  91. \fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
  92. \fancyfoot[CO]{\fancyplain{}{}}
  93. \fancyfoot[RO]{\fancyplain{}{}}
  94. \renewcommand{\footrulewidth}{0.4pt}
  95. \renewcommand{\chaptermark}[1]{%
  96. \markboth{#1}{}%
  97. }
  98. \renewcommand{\sectionmark}[1]{%
  99. \markright{\thesection\ #1}%
  100. }
  101. % Indices & bibliography
  102. \usepackage{natbib}
  103. \usepackage[titles]{tocloft}
  104. \setcounter{tocdepth}{3}
  105. \setcounter{secnumdepth}{5}
  106. \makeindex
  107. \usepackage{newunicodechar}
  108. \newunicodechar{⁻}{${}^{-}$}% Superscript minus
  109. \newunicodechar{²}{${}^{2}$}% Superscript two
  110. \newunicodechar{³}{${}^{3}$}% Superscript three
  111. % Hyperlinks (required, but should be loaded last)
  112. \ifpdf
  113. \usepackage[pdftex,pagebackref=true]{hyperref}
  114. \else
  115. \ifxetex
  116. \usepackage[pagebackref=true]{hyperref}
  117. \else
  118. \usepackage[ps2pdf,pagebackref=true]{hyperref}
  119. \fi
  120. \fi
  121. \hypersetup{%
  122. colorlinks=true,%
  123. linkcolor=blue,%
  124. citecolor=blue,%
  125. unicode%
  126. }
  127. % Custom commands
  128. \newcommand{\clearemptydoublepage}{%
  129. \newpage{\pagestyle{empty}\cleardoublepage}%
  130. }
  131. \usepackage{caption}
  132. \captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
  133. \usepackage{etoc}
  134. \etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
  135. \renewcommand{\numberline}[1]{#1~}
  136. %===== C O N T E N T S =====
  137. \begin{document}
  138. % Titlepage & ToC
  139. \hypersetup{pageanchor=false,
  140. bookmarksnumbered=true,
  141. pdfencoding=unicode
  142. }
  143. \pagenumbering{alph}
  144. \begin{titlepage}
  145. \vspace*{7cm}
  146. \begin{center}%
  147. {\Large Richards fast slow \\[1ex]\large 0.\+001 }\\
  148. \vspace*{1cm}
  149. {\large Generated by Doxygen 1.8.20}\\
  150. \end{center}
  151. \end{titlepage}
  152. \clearemptydoublepage
  153. \pagenumbering{roman}
  154. \tableofcontents
  155. \clearemptydoublepage
  156. \pagenumbering{arabic}
  157. \hypersetup{pageanchor=true}
  158. %--- Begin generated contents ---
  159. \chapter{Class Index}
  160. \input{annotated}
  161. \chapter{Class Documentation}
  162. \input{class_model}
  163. \input{class_model_b_c}
  164. \input{class_physics}
  165. %--- End generated contents ---
  166. % Index
  167. \backmatter
  168. \newpage
  169. \phantomsection
  170. \clearemptydoublepage
  171. \addcontentsline{toc}{chapter}{\indexname}
  172. \printindex
  173. \end{document}