doc/doxygen_manual.tex

   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 \usepackage[a4paper,left=2.5cm,right=2.5cm,top=2.5cm,bottom=2.5cm]{geometry}
  18 \usepackage{makeidx}
  19 \usepackage{natbib}
  20 \usepackage{graphicx}
  21 \usepackage{multicol}
  22 \usepackage{float}
  23 \usepackage{geometry}
  24 \usepackage{listings}
  25 \usepackage{color}
  26 \usepackage{ifthen}
  27 \usepackage[table]{xcolor}
  28 \PassOptionsToPackage{warn}{textcomp}
  29 \usepackage{textcomp}
  30 \usepackage[nointegrals]{wasysym}
  31 \usepackage{alltt}
  32 \usepackage{import}
  33 \usepackage[titletoc]{appendix}
  34 \usepackage{ifpdf}
  35 \ifpdf
  36 \usepackage[pdftex,
  37             pagebackref=true,
  38             colorlinks=true,
  39             linkcolor=blue,
  40             unicode
  41            ]{hyperref}
  42 \else
  43 \usepackage[ps2pdf,
  44             pagebackref=true,
  45             colorlinks=true,
  46             linkcolor=blue,
  47             unicode
  48            ]{hyperref}
  49 \usepackage{pspicture}
  50 \fi
  51 \usepackage[utf8]{inputenc}
  52 \usepackage{mathptmx}
  53 \usepackage[scaled=.90]{helvet}
  54 \usepackage{courier}
  55 \usepackage{sectsty}
  56 \usepackage[titles]{tocloft}
  57 \usepackage{amssymb}
  58 \usepackage{doxygen}
  59 \usepackage{manual}
  60 \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
  61 \lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
  62 \makeindex
  63 \setcounter{tocdepth}{3}
  64 \renewcommand{\footrulewidth}{0.4pt}
  65 \renewcommand{\familydefault}{\sfdefault}
  66 \renewcommand{\cftsecindent}{0 em}
  67 \renewcommand{\cftsecnumwidth}{3.2 em}
  68 \renewcommand{\cftsubsecindent}{3.2 em}
  69 \newcommand{\thisyear}{\the\year}
  70 \hfuzz=15pt
  71 \setlength{\emergencystretch}{15pt}
  72 \setlength{\parindent}{0pt}
  73 \newcommand{\doxynormalparskip}{\setlength{\parskip}{0.2cm}}
  74 \newcommand{\doxytocparskip}{\setlength{\parskip}{0.2cm}}
  75 \newcommand{\doxygenemoji}[2]{%
  76 \IfFileExists{../doc/#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{../doc/#2.png}}}{#1}}
  77 \doxynormalparskip
  78 \hbadness=750
  79 \tolerance=750
  80 \usepackage{etoc}
  81 \etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
  82 \begin{document}
  83 \pagenumbering{alph}
  84 \begin{titlepage}
  85 \includegraphics[width=\textwidth]{doxygen_logo}
  86 \begin{center}
  87 Manual for version @VERSION@\\[2ex]
  88 Written by Dimitri van Heesch\\[2ex]
  89 \copyright 1997-\thisyear
  90 \end{center}
  91 \end{titlepage}
  92 \clearemptydoublepage
  93 \pagenumbering{Roman}
  94 \chapter*{Contents}
  95 \tableofcontents
  96 \clearemptydoublepage
  97 \pagenumbering{arabic}
  98 \part{User Manual}
  99 \chapter{Introduction}\label{intro}\hypertarget{intro}{}\input{index}
 100 \chapter{Installation}\label{install}\hypertarget{install}{}\input{install}
 101 \chapter{Getting started}\label{starting}\hypertarget{starting}{}\input{starting}
 102 \chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks}
 103 \chapter{Markdown support}\label{markdown}\hypertarget{markdown}{}\input{markdown}
 104 \chapter{Lists}\label{lists}\hypertarget{lists}{}\input{lists}
 105 \chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping}
 106 \chapter{Including formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas}
 107 \chapter{Including tables}\label{tables}\hypertarget{tables}{}\input{tables}
 108 \chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams}
 109 \chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing}
 110 \chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink}
 111 \chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output}
 112 \chapter{Searching}\label{searching}\hypertarget{searching}{}\input{searching}
 113 \chapter{Customizing the output}\label{customize}\hypertarget{customize}{}\input{customize}
 114 \chapter{Custom commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd}
 115 \chapter{Linking to external documentation}\label{external}\hypertarget{external}{}\input{external}
 116 \chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq}
 117 \chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble}
 118 \part{Reference Manual}
 119 \chapter{Features}\label{features}\hypertarget{features}{}\input{features}
 120 \chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage}
 121 \chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage}
 122 \chapter{Configuration}\label{config}\hypertarget{config}{}\input{config}
 123 \chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands}
 124 \chapter{HTML Commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds}
 125 \chapter{XML Commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds}
 126 \chapter{Emoji support}\label{emojisup}\hypertarget{emojisup}{}\input{emojisup}
 127 \part{Developers Manual}
 128 \chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto}
 129 \chapter{Perl Module Output}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod}
 130 \chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch}
 131 \renewcommand{\thepart}{}
 132 \part{Appendices}
 133 \appendix
 134 %mean that subinputfrom requires a / at the end of the path
 135 \chapter{Autolink Example}\label{autolink_example}\hypertarget{autolink_example}{}
 136 \subinputfrom{../html/examples/autolink/latex/}{refman_doc}
 137 \chapter{Resolving Typedef Example}\label{restypedef_example}\hypertarget{restypedef_example}{}
 138 \subinputfrom{../html/examples/restypedef/latex/}{refman_doc}
 139
 140 \IfFileExists{../html/examples/diagrams/latex/refman_doc.tex}
 141 {
 142   \chapter{Diagrams Example}\label{diagrams_example}\hypertarget{diagrams_example}{}
 143   \subinputfrom{../html/examples/diagrams/latex/}{refman_doc}
 144 }{}
 145
 146 \chapter{Modules Example}\label{modules_example}\hypertarget{modules_example}{}
 147 \subinputfrom{../html/examples/group/latex/}{refman_doc}
 148 \chapter{Member Groups Example}\label{memgrp_example}\hypertarget{memgrp_example}{}
 149 \subinputfrom{../html/examples/memgrp/latex/}{refman_doc}
 150 \chapter{After Block Example}\label{afterdoc_example}\hypertarget{afterdoc_example}{}
 151 \subinputfrom{../html/examples/afterdoc/latex/}{refman_doc}
 152 \chapter{QT Style Example}\label{qtstyle_example}\hypertarget{qtstyle_example}{}
 153 \subinputfrom{../html/examples/qtstyle/latex/}{refman_doc}
 154 \chapter{Javadoc Style Example}\label{jdstyle_example}\hypertarget{jdstyle_example}{}
 155 \subinputfrom{../html/examples/jdstyle/latex/}{refman_doc}
 156 \chapter{Structural Commands Example}\label{structcmd_example}\hypertarget{structcmd_example}{}
 157 \subinputfrom{../html/examples/structcmd/latex/}{refman_doc}
 158 \chapter{Python Docstring Example}\label{python_example}\hypertarget{python_example}{}
 159 \subinputfrom{../html/examples/docstring/latex/}{refman_doc}
 160 \chapter{Python Example}\label{py_example}\hypertarget{py_example}{}
 161 \subinputfrom{../html/examples/pyexample/latex/}{refman_doc}
 162 \chapter{VHDL Example}\label{vhdl_example}\hypertarget{vhdl_example}{}
 163 \subinputfrom{../html/examples/mux/latex/}{refman_doc}
 164 \chapter{Tcl Example}\label{tcl_example}\hypertarget{tcl_example}{}
 165 \subinputfrom{../html/examples/tclexample/latex/}{refman_doc}
 166
 167 \chapter{Class Example}\label{class_example}\hypertarget{class_example}{}
 168 \subinputfrom{../html/examples/class/latex/}{refman_doc}
 169 \chapter{Define Example}\label{define_example}\hypertarget{define_example}{}
 170 \subinputfrom{../html/examples/define/latex/}{refman_doc}
 171 \chapter{Enum Example}\label{enum_example}\hypertarget{enum_example}{}
 172 \subinputfrom{../html/examples/enum/latex/}{refman_doc}
 173 \chapter{Example Example}\label{example_example}\hypertarget{example_example}{}
 174 \subinputfrom{../html/examples/example/latex/}{refman_doc}
 175 \chapter{Extends/Implements Example}\label{extends_example}\hypertarget{extends_example}{}
 176 \subinputfrom{../html/examples/manual/latex/}{refman_doc}
 177 \chapter{File Example}\label{file_example}\hypertarget{file_example}{}
 178 \subinputfrom{../html/examples/file/latex/}{refman_doc}
 179 \chapter{Fn Example}\label{fn_example}\hypertarget{fn_example}{}
 180 \subinputfrom{../html/examples/func/latex/}{refman_doc}
 181 \chapter{Overload Example}\label{overload_example}\hypertarget{overload_example}{}
 182 \subinputfrom{../html/examples/overload/latex/}{refman_doc}
 183 \chapter{Page Example}\label{page_example}\hypertarget{page_example}{}
 184 \subinputfrom{../html/examples/page/latex/}{refman_doc}
 185 \chapter{Relates Example}\label{relates_example}\hypertarget{relates_example}{}
 186 \subinputfrom{../html/examples/relates/latex/}{refman_doc}
 187 \chapter{Author Example}\label{author_example}\hypertarget{author_example}{}
 188 \subinputfrom{../html/examples/author/latex/}{refman_doc}
 189 \chapter{Par Example}\label{par_example}\hypertarget{par_example}{}
 190 \subinputfrom{../html/examples/par/latex/}{refman_doc}
 191 \chapter{Include Example}\label{include_example}\hypertarget{include_example}{}
 192 \subinputfrom{../html/examples/include/latex/}{refman_doc}
 193
 194
 195 \printindex
 196 \end{document}