1% 2% 3% 4% Copyright (C) 1997-2015 by Dimitri van Heesch. 5% 6% Permission to use, copy, modify, and distribute this software and its 7% documentation under the terms of the GNU General Public License is hereby 8% granted. No representations are made about the suitability of this software 9% for any purpose. It is provided "as is" without express or implied warranty. 10% See the GNU General Public License for more details. 11% 12% Documents produced by Doxygen are derivative works derived from the 13% input used in their production; they are not affected by this license. 14 15\batchmode 16\documentclass{book} 17%% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package 18\usepackage{ifthen} 19\ifx\requestedLaTeXdate\undefined 20\usepackage{array} 21\else 22\usepackage{array}[=2016-10-06] 23\fi 24%% 25\usepackage[left=2.5cm,right=2.5cm,top=2.5cm,bottom=2.5cm]{geometry} 26\usepackage{makeidx} 27\usepackage{natbib} 28\usepackage{graphicx} 29\usepackage{multicol} 30\usepackage{float} 31\usepackage{geometry} 32\usepackage{listings} 33\usepackage{color} 34%%\usepackage{ifthen} %% moved to top due to workaround for LaTex 2019 version and unmaintained tabu package 35\usepackage[table]{xcolor} 36\PassOptionsToPackage{warn}{textcomp} 37\usepackage{textcomp} 38\usepackage[nointegrals]{wasysym} 39\usepackage{alltt} 40\usepackage{import} 41\usepackage[titletoc]{appendix} 42\usepackage{ifpdf} 43\ifpdf 44\usepackage[pdftex, 45 pagebackref=true, 46 colorlinks=true, 47 linkcolor=blue, 48 unicode 49 ]{hyperref} 50\else 51\usepackage[ps2pdf, 52 pagebackref=true, 53 colorlinks=true, 54 linkcolor=blue, 55 unicode 56 ]{hyperref} 57\usepackage{pspicture} 58\fi 59\usepackage[utf8]{inputenc} 60\usepackage{mathptmx} 61\usepackage[scaled=.90]{helvet} 62\usepackage{courier} 63\usepackage{sectsty} 64\usepackage[titles]{tocloft} 65\usepackage{amssymb} 66\usepackage{doxygen} 67\usepackage{manual} 68%% 69%gave problems when in doxygen.sty 70\makeatletter 71\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@} 72\makeatother 73%% 74% unfortunately constructs like: 75% \renewcommand{\doxysection}[1]{\doxysubsection{##1}} 76% using values from book.cls (see also doxygen.sty) and redefining sections to correct level. 77\makeatletter 78\newenvironment{DoxygenSubAppendix}{% 79\renewcommand\doxysection{\@startsection{subsection}{2}{\z@}% 80 {-3.25ex\@plus -1ex \@minus -.2ex}% 81 {1.5ex \@plus .2ex}% 82 {\raggedright\normalfont\large\bfseries}} 83\renewcommand\doxysubsection{\@startsection{subsubsection}{3}{\z@}% 84 {-3.25ex\@plus -1ex \@minus -.2ex}% 85 {1.5ex \@plus .2ex}% 86 {\raggedright\normalfont\normalsize\bfseries}} 87\renewcommand\doxysubsubsection{\@startsection{paragraph}{4}{\z@}% 88 {3.25ex \@plus1ex \@minus.2ex}% 89 {-1em}% 90 {\raggedright\normalfont\normalsize\bfseries}} 91\renewcommand\doxyparagraph{\@startsection{subparagraph}{5}{\parindent}% 92 {3.25ex \@plus1ex \@minus .2ex}% 93 {-1em}% 94 {\raggedright\normalfont\normalsize\bfseries}} 95%%\renewcommand{\doxysection}[1]{\doxysubsection{##1}} 96%%\renewcommand{\doxysubsection}[1]{\doxysubsubsection{##1}} 97%%\renewcommand{\doxysubsubsection}[1]{\doxyparagraph{##1}} 98%%\renewcommand{\doxyparagraph}[1]{\doxysubparagraph{##1}} 99}{} 100\makeatother 101%% 102\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} 103\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left } 104\makeindex 105\setcounter{tocdepth}{3} 106\renewcommand{\footrulewidth}{0.4pt} 107\renewcommand{\familydefault}{\sfdefault} 108\renewcommand{\cftsecindent}{0 em} 109\renewcommand{\cftsecnumwidth}{3.2 em} 110\renewcommand{\cftsubsecindent}{3.2 em} 111\newcommand{\thisyear}{\the\year} 112\hfuzz=15pt 113\setlength{\emergencystretch}{15pt} 114\setlength{\parindent}{0pt} 115\newcommand{\doxynormalparskip}{\setlength{\parskip}{0.2cm}} 116\newcommand{\doxytocparskip}{\setlength{\parskip}{0.2cm}} 117\newcommand{\doxygenemoji}[2]{% 118\IfFileExists{../doc/#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{../doc/#2.png}}}{#1}} 119\doxynormalparskip 120\hbadness=750 121\tolerance=750 122\usepackage{etoc} 123\etocsettocstyle{\doxytocparskip}{\doxynormalparskip} 124\begin{document} 125\raggedbottom 126\pagenumbering{alph} 127\begin{titlepage} 128\includegraphics[width=\textwidth]{doxygen_logo} 129\begin{center} 130Manual for version @VERSION@\\[2ex] 131Written by Dimitri van Heesch\\[2ex] 132\copyright 1997-\thisyear 133\end{center} 134\end{titlepage} 135\clearemptydoublepage 136\pagenumbering{Roman} 137\chapter*{Contents} 138\tableofcontents 139\clearemptydoublepage 140\pagenumbering{arabic} 141\part{User Manual} 142\chapter{Introduction}\label{intro}\hypertarget{intro}{}\input{index} 143\chapter{Installation}\label{install}\hypertarget{install}{}\input{install} 144\chapter{Getting started}\label{starting}\hypertarget{starting}{}\input{starting} 145\chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks} 146\chapter{Markdown support}\label{markdown}\hypertarget{markdown}{}\input{markdown} 147\chapter{Lists}\label{lists}\hypertarget{lists}{}\input{lists} 148\chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping} 149\chapter{Including formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas} 150\chapter{Including tables}\label{tables}\hypertarget{tables}{}\input{tables} 151\chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams} 152\chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing} 153\chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink} 154\chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output} 155\chapter{Searching}\label{searching}\hypertarget{searching}{}\input{searching} 156\chapter{Customizing the output}\label{customize}\hypertarget{customize}{}\input{customize} 157\chapter{Custom commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd} 158\chapter{Linking to external documentation}\label{external}\hypertarget{external}{}\input{external} 159\chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq} 160\chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble} 161\part{Reference Manual} 162\chapter{Features}\label{features}\hypertarget{features}{}\input{features} 163\chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage} 164\chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage} 165\chapter{Configuration}\label{config}\hypertarget{config}{}\input{config} 166\chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands} 167\chapter{HTML Commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds} 168\chapter{XML Commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds} 169\chapter{Emoji support}\label{emojisup}\hypertarget{emojisup}{}\input{emojisup} 170\part{Developers Manual} 171\chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto} 172\chapter{Perl Module Output}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod} 173\chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch} 174\renewcommand{\thepart}{} 175\renewcommand{\partname}{} 176\part{Appendices} 177\appendix 178%mean that subinputfrom requires a / at the end of the path 179\chapter{Autolink Example}\label{autolink_example}\hypertarget{autolink_example}{} 180\subinputfrom{examples/autolink/latex/}{refman_doc} 181\chapter{Resolving Typedef Example}\label{restypedef_example}\hypertarget{restypedef_example}{} 182\subinputfrom{examples/restypedef/latex/}{refman_doc} 183 184\IfFileExists{examples/diagrams/latex/refman_doc.tex} 185{ 186 \chapter{Diagrams Example}\label{diagrams_example}\hypertarget{diagrams_example}{} 187 \subinputfrom{examples/diagrams/latex/}{refman_doc} 188}{} 189 190\chapter{Modules Example}\label{modules_example}\hypertarget{modules_example}{} 191\subinputfrom{examples/group/latex/}{refman_doc} 192\chapter{Member Groups Example}\label{memgrp_example}\hypertarget{memgrp_example}{} 193\subinputfrom{examples/memgrp/latex/}{refman_doc} 194\chapter{Style Examples} 195 \doxysection{After Block Example}\label{afterdoc_example}\hypertarget{afterdoc_example}{} 196 \begin{DoxygenSubAppendix} 197 \subinputfrom{examples/afterdoc/latex/}{refman_doc} 198 \end{DoxygenSubAppendix} 199 \doxysection{QT Style Example}\label{qtstyle_example}\hypertarget{qtstyle_example}{} 200 \begin{DoxygenSubAppendix} 201 \subinputfrom{examples/qtstyle/latex/}{refman_doc} 202 \end{DoxygenSubAppendix} 203 \doxysection{Javadoc Style Example}\label{jdstyle_example}\hypertarget{jdstyle_example}{} 204 \begin{DoxygenSubAppendix} 205 \subinputfrom{examples/jdstyle/latex/}{refman_doc} 206 \end{DoxygenSubAppendix} 207 \doxysection{Javadoc Banner Example}\label{javadoc_banner_example}\hypertarget{javadoc_banner_example}{} 208 \begin{DoxygenSubAppendix} 209 \subinputfrom{examples/javadoc-banner/latex/}{refman_doc} 210 \end{DoxygenSubAppendix} 211\chapter{Structural Commands Example}\label{structcmd_example}\hypertarget{structcmd_example}{} 212\subinputfrom{examples/structcmd/latex/}{refman_doc} 213\chapter{Language Examples} 214 \doxysection{Python Docstring Example}\label{python_example}\hypertarget{python_example}{} 215 \begin{DoxygenSubAppendix} 216 \subinputfrom{examples/docstring/latex/}{refman_doc} 217 \end{DoxygenSubAppendix} 218 \doxysection{Python Example}\label{py_example}\hypertarget{py_example}{} 219 \begin{DoxygenSubAppendix} 220 \subinputfrom{examples/pyexample/latex/}{refman_doc} 221 \end{DoxygenSubAppendix} 222 \doxysection{VHDL Example}\label{vhdl_example}\hypertarget{vhdl_example}{} 223 \begin{DoxygenSubAppendix} 224 \subinputfrom{examples/mux/latex/}{refman_doc} 225 \end{DoxygenSubAppendix} 226 227\chapter{Class Example}\label{class_example}\hypertarget{class_example}{} 228\subinputfrom{examples/class/latex/}{refman_doc} 229\chapter{Define Example}\label{define_example}\hypertarget{define_example}{} 230\subinputfrom{examples/define/latex/}{refman_doc} 231\chapter{Enum Example}\label{enum_example}\hypertarget{enum_example}{} 232\subinputfrom{examples/enum/latex/}{refman_doc} 233\chapter{Example Example}\label{example_example}\hypertarget{example_example}{} 234\subinputfrom{examples/example/latex/}{refman_doc} 235\chapter{Extends/Implements Example}\label{extends_example}\hypertarget{extends_example}{} 236\subinputfrom{examples/manual/latex/}{refman_doc} 237\chapter{File Example}\label{file_example}\hypertarget{file_example}{} 238\subinputfrom{examples/file/latex/}{refman_doc} 239\chapter{Fn Example}\label{fn_example}\hypertarget{fn_example}{} 240\subinputfrom{examples/func/latex/}{refman_doc} 241\chapter{Overload Example}\label{overload_example}\hypertarget{overload_example}{} 242\subinputfrom{examples/overload/latex/}{refman_doc} 243\chapter{Page Example}\label{page_example}\hypertarget{page_example}{} 244\subinputfrom{examples/page/latex/}{refman_doc} 245\chapter{Relates Example}\label{relates_example}\hypertarget{relates_example}{} 246\subinputfrom{examples/relates/latex/}{refman_doc} 247\chapter{Author Example}\label{author_example}\hypertarget{author_example}{} 248\subinputfrom{examples/author/latex/}{refman_doc} 249\chapter{Par Example}\label{par_example}\hypertarget{par_example}{} 250\subinputfrom{examples/par/latex/}{refman_doc} 251\chapter{Include Example}\label{include_example}\hypertarget{include_example}{} 252\subinputfrom{examples/include/latex/}{refman_doc} 253 254 255\printindex 256\end{document} 257