Orb/Doxygen/doc/doxygen_manual.tex
changeset 0 42188c7ea2d9
equal deleted inserted replaced
-1:000000000000 0:42188c7ea2d9
       
     1 %
       
     2 % 
       
     3 %
       
     4 % Copyright (C) 1997-2007 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[a4paper]{report}
       
    16 \usepackage{a4wide}
       
    17 \usepackage{makeidx}
       
    18 \usepackage{fancyhdr}
       
    19 \usepackage{float}
       
    20 \usepackage{graphicx}
       
    21 \usepackage{epsf}
       
    22 \usepackage{doxygen}
       
    23 \usepackage{multicol}
       
    24 \usepackage{times}
       
    25 \usepackage{alltt}
       
    26 \usepackage{tocloft}
       
    27 \usepackage[pdftex,
       
    28             pagebackref=true,
       
    29             colorlinks=true,
       
    30             linkcolor=blue
       
    31            ]{hyperref}
       
    32 \makeindex
       
    33 \setcounter{tocdepth}{1}
       
    34 \renewcommand{\footrulewidth}{0.4pt}
       
    35 \renewcommand{\cftsecindent}{0 em}
       
    36 \renewcommand{\cftsecnumwidth}{3.2 em}
       
    37 \renewcommand{\cftsubsecindent}{3.2 em}
       
    38 \begin{document}
       
    39 \begin{titlepage}
       
    40 \includegraphics[width=\textwidth]{doxygen_logo}
       
    41 \begin{center}
       
    42 Manual for version $VERSION\\[2ex]
       
    43 Written by Dimitri van Heesch\\[2ex]
       
    44 \copyright 1997-2007
       
    45 \end{center}
       
    46 \end{titlepage}
       
    47 \clearemptydoublepage
       
    48 \tableofcontents
       
    49 \clearemptydoublepage
       
    50 \pagenumbering{arabic}
       
    51 \include{index}
       
    52 \part{User Manual}
       
    53 \chapter{Installation}\label{install}\hypertarget{install}{}\input{install}
       
    54 \chapter{Getting Started}\label{starting}\hypertarget{starting}{}\input{starting}
       
    55 \chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks}
       
    56 \chapter{Lists}\label{lists}\hypertarget{lists}{}\input{lists}
       
    57 \chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping}
       
    58 \chapter{Including Formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas}
       
    59 \chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams}
       
    60 \chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing}
       
    61 \chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink}
       
    62 \chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output}
       
    63 \chapter{Searching}\label{searching}\hypertarget{searching}{}\input{searching}
       
    64 \chapter{Customizing the Output}\label{customize}\hypertarget{customize}{}\input{customize}
       
    65 \chapter{Custom Commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd}
       
    66 \chapter{Link to external documentation}\label{external}\hypertarget{external}{}\input{external}
       
    67 \chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq}
       
    68 \chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble}
       
    69 \part{Reference Manual}
       
    70 \chapter{Features}\label{features}\hypertarget{features}{}\input{features}
       
    71 \chapter{Doxygen History}\label{history}\hypertarget{history}{}\input{history}
       
    72 \chapter{Doxygen usage}\label{doxygen__usage}\hypertarget{doxygen__usage}{}\input{doxygen__usage}
       
    73 \chapter{Doxytag usage}\label{doxytag__usage}\hypertarget{doxytag__usage}{}\input{doxytag__usage}
       
    74 \chapter{Doxywizard usage}\label{doxywizard__usage}\hypertarget{doxywizard__usage}{}\input{doxywizard__usage}
       
    75 \chapter{Installdox usage}\label{installdox__usage}\hypertarget{installdox__usage}{}\input{installdox__usage}
       
    76 \chapter{Configuration}\label{config}\hypertarget{config}{}\input{config}
       
    77 \chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands}
       
    78 \chapter{HTML commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds}
       
    79 \chapter{XML commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds}
       
    80 \part{Developers Manual}
       
    81 \chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch}
       
    82 \chapter{Perl Module Output format}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod}
       
    83 \chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto}
       
    84 \printindex
       
    85 \end{document}