doc/doxygen_manual.tex

   1 %
   2 %
   3 %
   4 % Copyright (C) 1997-2011 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 \documentclass{book}
  16 \usepackage[a4paper,left=2.5cm,right=2.5cm,top=2.5cm,bottom=2.5cm]{geometry}
  17 \usepackage{makeidx}
  18 \usepackage{natbib}
  19 \usepackage{graphicx}
  20 \usepackage{multicol}
  21 \usepackage{float}
  22 \usepackage{geometry}
  23 \usepackage{listings}
  24 \usepackage{color}
  25 \usepackage{ifthen}
  26 \usepackage[table]{xcolor}
  27 \usepackage{textcomp}
  28 \usepackage{alltt}
  29 \usepackage{ifpdf}
  30 \ifpdf
  31 \usepackage[pdftex,
  32             pagebackref=true,
  33             colorlinks=true,
  34             linkcolor=blue,
  35             unicode
  36            ]{hyperref}
  37 \else
  38 \usepackage[ps2pdf,
  39             pagebackref=true,
  40             colorlinks=true,
  41             linkcolor=blue,
  42             unicode
  43            ]{hyperref}
  44 \usepackage{pspicture}
  45 \fi
  46 \usepackage[utf8]{inputenc}
  47 \usepackage{mathptmx}
  48 \usepackage[scaled=.90]{helvet}
  49 \usepackage{courier}
  50 \usepackage{sectsty}
  51 \usepackage[titles]{tocloft}
  52 \usepackage{amssymb}
  53 \usepackage{doxygen}
  54 \lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
  55 \makeindex
  56 \setcounter{tocdepth}{3}
  57 \renewcommand{\footrulewidth}{0.4pt}
  58 \renewcommand{\familydefault}{\sfdefault}
  59 \renewcommand{\cftsecindent}{0 em}
  60 \renewcommand{\cftsecnumwidth}{3.2 em}
  61 \renewcommand{\cftsubsecindent}{3.2 em}
  62 \newcommand{\thisyear}{\the\year}
  63 \hfuzz=15pt
  64 \setlength{\emergencystretch}{15pt}
  65 \hbadness=750
  66 \tolerance=750
  67 \begin{document}
  68 \begin{titlepage}
  69 \includegraphics[width=\textwidth]{doxygen_logo}
  70 \begin{center}
  71 Manual for version $VERSION\\[2ex]
  72 Written by Dimitri van Heesch\\[2ex]
  73 \copyright 1997-\thisyear
  74 \end{center}
  75 \end{titlepage}
  76 \clearemptydoublepage
  77 \tableofcontents
  78 \clearemptydoublepage
  79 \pagenumbering{arabic}
  80 \include{index}
  81 \part{User Manual}
  82 \chapter{Installation}\label{install}\hypertarget{install}{}\input{install}
  83 \chapter{Getting Started}\label{starting}\hypertarget{starting}{}\input{starting}
  84 \chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks}
  85 \chapter{Markdown}\label{markdown}\hypertarget{markdown}{}\input{markdown}
  86 \chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping}
  87 \chapter{Including Formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas}
  88 \chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams}
  89 \chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing}
  90 \chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink}
  91 \chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output}
  92 \chapter{Searching}\label{searching}\hypertarget{searching}{}\input{searching}
  93 \chapter{Customizing the Output}\label{customize}\hypertarget{customize}{}\input{customize}
  94 \chapter{Custom Commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd}
  95 \chapter{Link to external documentation}\label{external}\hypertarget{external}{}\input{external}
  96 \chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq}
  97 \chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble}
  98 \part{Reference Manual}
  99 \chapter{Features}\label{features}\hypertarget{features}{}\input{features}
 100 \chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage}
 101 \chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage}
 102 \chapter{Configuration}\label{config}\hypertarget{config}{}\input{config}
 103 \chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands}
 104 \chapter{HTML commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds}
 105 \chapter{XML commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds}
 106 \part{Developers Manual}
 107 \chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch}
 108 \chapter{Perl Module Output format}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod}
 109 \chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto}
 110 \printindex
 111 \end{document}