|
Packit |
1c1d7e |
%
|
|
Packit |
1c1d7e |
%
|
|
Packit |
1c1d7e |
%
|
|
Packit |
1c1d7e |
% Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit |
1c1d7e |
%
|
|
Packit |
1c1d7e |
% Permission to use, copy, modify, and distribute this software and its
|
|
Packit |
1c1d7e |
% documentation under the terms of the GNU General Public License is hereby
|
|
Packit |
1c1d7e |
% granted. No representations are made about the suitability of this software
|
|
Packit |
1c1d7e |
% for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit |
1c1d7e |
% See the GNU General Public License for more details.
|
|
Packit |
1c1d7e |
%
|
|
Packit |
1c1d7e |
% Documents produced by Doxygen are derivative works derived from the
|
|
Packit |
1c1d7e |
% input used in their production; they are not affected by this license.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\batchmode
|
|
Packit |
1c1d7e |
\documentclass{book}
|
|
Packit |
1c1d7e |
\usepackage[a4paper,left=2.5cm,right=2.5cm,top=2.5cm,bottom=2.5cm]{geometry}
|
|
Packit |
1c1d7e |
\usepackage{makeidx}
|
|
Packit |
1c1d7e |
\usepackage{natbib}
|
|
Packit |
1c1d7e |
\usepackage{graphicx}
|
|
Packit |
1c1d7e |
\usepackage{multicol}
|
|
Packit |
1c1d7e |
\usepackage{float}
|
|
Packit |
1c1d7e |
\usepackage{geometry}
|
|
Packit |
1c1d7e |
\usepackage{listings}
|
|
Packit |
1c1d7e |
\usepackage{color}
|
|
Packit |
1c1d7e |
\usepackage{ifthen}
|
|
Packit |
1c1d7e |
\usepackage[table]{xcolor}
|
|
Packit |
1c1d7e |
\PassOptionsToPackage{warn}{textcomp}
|
|
Packit |
1c1d7e |
\usepackage{textcomp}
|
|
Packit |
1c1d7e |
\usepackage[nointegrals]{wasysym}
|
|
Packit |
1c1d7e |
\usepackage{alltt}
|
|
Packit |
1c1d7e |
\usepackage{import}
|
|
Packit |
1c1d7e |
\usepackage[titletoc]{appendix}
|
|
Packit |
1c1d7e |
\usepackage{ifpdf}
|
|
Packit |
1c1d7e |
\ifpdf
|
|
Packit |
1c1d7e |
\usepackage[pdftex,
|
|
Packit |
1c1d7e |
pagebackref=true,
|
|
Packit |
1c1d7e |
colorlinks=true,
|
|
Packit |
1c1d7e |
linkcolor=blue,
|
|
Packit |
1c1d7e |
unicode
|
|
Packit |
1c1d7e |
]{hyperref}
|
|
Packit |
1c1d7e |
\else
|
|
Packit |
1c1d7e |
\usepackage[ps2pdf,
|
|
Packit |
1c1d7e |
pagebackref=true,
|
|
Packit |
1c1d7e |
colorlinks=true,
|
|
Packit |
1c1d7e |
linkcolor=blue,
|
|
Packit |
1c1d7e |
unicode
|
|
Packit |
1c1d7e |
]{hyperref}
|
|
Packit |
1c1d7e |
\usepackage{pspicture}
|
|
Packit |
1c1d7e |
\fi
|
|
Packit |
1c1d7e |
\usepackage[utf8]{inputenc}
|
|
Packit |
1c1d7e |
\usepackage{mathptmx}
|
|
Packit |
1c1d7e |
\usepackage[scaled=.90]{helvet}
|
|
Packit |
1c1d7e |
\usepackage{courier}
|
|
Packit |
1c1d7e |
\usepackage{sectsty}
|
|
Packit |
1c1d7e |
\usepackage[titles]{tocloft}
|
|
Packit |
1c1d7e |
\usepackage{amssymb}
|
|
Packit |
1c1d7e |
\usepackage{doxygen}
|
|
Packit |
1c1d7e |
\usepackage{manual}
|
|
Packit |
1c1d7e |
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
|
Packit |
1c1d7e |
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
|
|
Packit |
1c1d7e |
\makeindex
|
|
Packit |
1c1d7e |
\setcounter{tocdepth}{3}
|
|
Packit |
1c1d7e |
\renewcommand{\footrulewidth}{0.4pt}
|
|
Packit |
1c1d7e |
\renewcommand{\familydefault}{\sfdefault}
|
|
Packit |
1c1d7e |
\renewcommand{\cftsecindent}{0 em}
|
|
Packit |
1c1d7e |
\renewcommand{\cftsecnumwidth}{3.2 em}
|
|
Packit |
1c1d7e |
\renewcommand{\cftsubsecindent}{3.2 em}
|
|
Packit |
1c1d7e |
\newcommand{\thisyear}{\the\year}
|
|
Packit |
1c1d7e |
\hfuzz=15pt
|
|
Packit |
1c1d7e |
\setlength{\emergencystretch}{15pt}
|
|
Packit |
1c1d7e |
\setlength{\parindent}{0pt}
|
|
Packit |
1c1d7e |
\setlength{\parskip}{0.2cm}
|
|
Packit |
1c1d7e |
\hbadness=750
|
|
Packit |
1c1d7e |
\tolerance=750
|
|
Packit |
1c1d7e |
\begin{document}
|
|
Packit |
1c1d7e |
\pagenumbering{alph}
|
|
Packit |
1c1d7e |
\begin{titlepage}
|
|
Packit |
1c1d7e |
\includegraphics[width=\textwidth]{doxygen_logo}
|
|
Packit |
1c1d7e |
\begin{center}
|
|
Packit |
1c1d7e |
Manual for version @VERSION@\\[2ex]
|
|
Packit |
1c1d7e |
Written by Dimitri van Heesch\\[2ex]
|
|
Packit |
1c1d7e |
\copyright 1997-\thisyear
|
|
Packit |
1c1d7e |
\end{center}
|
|
Packit |
1c1d7e |
\end{titlepage}
|
|
Packit |
1c1d7e |
\clearemptydoublepage
|
|
Packit |
1c1d7e |
\pagenumbering{Roman}
|
|
Packit |
1c1d7e |
\tableofcontents
|
|
Packit |
1c1d7e |
\clearemptydoublepage
|
|
Packit |
1c1d7e |
\pagenumbering{arabic}
|
|
Packit |
1c1d7e |
\part{User Manual}
|
|
Packit |
1c1d7e |
\chapter{Introduction}\label{intro}\hypertarget{intro}{}\input{index}
|
|
Packit |
1c1d7e |
\chapter{Installation}\label{install}\hypertarget{install}{}\input{install}
|
|
Packit |
1c1d7e |
\chapter{Getting Started}\label{starting}\hypertarget{starting}{}\input{starting}
|
|
Packit |
1c1d7e |
\chapter{Documenting the code}\label{docblocks}\hypertarget{docblocks}{}\input{docblocks}
|
|
Packit |
1c1d7e |
\chapter{Markdown}\label{markdown}\hypertarget{markdown}{}\input{markdown}
|
|
Packit |
1c1d7e |
\chapter{Lists}\label{lists}\hypertarget{lists}{}\input{lists}
|
|
Packit |
1c1d7e |
\chapter{Grouping}\label{grouping}\hypertarget{grouping}{}\input{grouping}
|
|
Packit |
1c1d7e |
\chapter{Including Formulas}\label{formulas}\hypertarget{formulas}{}\input{formulas}
|
|
Packit |
1c1d7e |
\chapter{Including Tables}\label{tables}\hypertarget{tables}{}\input{tables}
|
|
Packit |
1c1d7e |
\chapter{Graphs and diagrams}\label{diagrams}\hypertarget{diagrams}{}\input{diagrams}
|
|
Packit |
1c1d7e |
\chapter{Preprocessing}\label{preprocessing}\hypertarget{preprocessing}{}\input{preprocessing}
|
|
Packit |
1c1d7e |
\chapter{Automatic link generation}\label{autolink}\hypertarget{autolink}{}\input{autolink}
|
|
Packit |
1c1d7e |
\chapter{Output Formats}\label{output}\hypertarget{output}{}\input{output}
|
|
Packit |
1c1d7e |
\chapter{Searching}\label{searching}\hypertarget{searching}{}\input{searching}
|
|
Packit |
1c1d7e |
\chapter{Customizing the Output}\label{customize}\hypertarget{customize}{}\input{customize}
|
|
Packit |
1c1d7e |
\chapter{Custom Commands}\label{custcmd}\hypertarget{custcmd}{}\input{custcmd}
|
|
Packit |
1c1d7e |
\chapter{Link to external documentation}\label{external}\hypertarget{external}{}\input{external}
|
|
Packit |
1c1d7e |
\chapter{Frequently Asked Questions}\label{faq}\hypertarget{faq}{}\input{faq}
|
|
Packit |
1c1d7e |
\chapter{Troubleshooting}\label{trouble}\hypertarget{trouble}{}\input{trouble}
|
|
Packit |
1c1d7e |
\part{Reference Manual}
|
|
Packit |
1c1d7e |
\chapter{Features}\label{features}\hypertarget{features}{}\input{features}
|
|
Packit |
1c1d7e |
\chapter{Doxygen usage}\label{doxygen_usage}\hypertarget{doxygen_usage}{}\input{doxygen_usage}
|
|
Packit |
1c1d7e |
\chapter{Doxywizard usage}\label{doxywizard_usage}\hypertarget{doxywizard_usage}{}\input{doxywizard_usage}
|
|
Packit |
1c1d7e |
\chapter{Configuration}\label{config}\hypertarget{config}{}\input{config}
|
|
Packit |
1c1d7e |
\chapter{Special Commands}\label{commands}\hypertarget{commands}{}\input{commands}
|
|
Packit |
1c1d7e |
\chapter{HTML commands}\label{htmlcmds}\hypertarget{htmlcmds}{}\input{htmlcmds}
|
|
Packit |
1c1d7e |
\chapter{XML commands}\label{xmlcmds}\hypertarget{xmlcmds}{}\input{xmlcmds}
|
|
Packit |
1c1d7e |
\part{Developers Manual}
|
|
Packit |
1c1d7e |
\chapter{Doxygen's internals}\label{arch}\hypertarget{arch}{}\input{arch}
|
|
Packit |
1c1d7e |
\chapter{Perl Module Output format}\label{perlmod}\hypertarget{perlmod}{}\input{perlmod}
|
|
Packit |
1c1d7e |
\chapter{Internationalization}\label{langhowto}\hypertarget{langhowto}{}\input{langhowto}
|
|
Packit |
1c1d7e |
\renewcommand{\thepart}{}
|
|
Packit |
1c1d7e |
\part{Appendices}
|
|
Packit |
1c1d7e |
\appendix
|
|
Packit |
1c1d7e |
%mean that subinputfrom requires a / at the end of the path
|
|
Packit |
1c1d7e |
\chapter{Autolink Example}\label{autolink_example}\hypertarget{autolink_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/autolink/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Resolving Typedef Example}\label{restypedef_example}\hypertarget{restypedef_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/restypedef/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\IfFileExists{../html/examples/diagrams/latex/refman_doc.tex}
|
|
Packit |
1c1d7e |
{
|
|
Packit |
1c1d7e |
\chapter{Diagrams Example}\label{diagrams_example}\hypertarget{diagrams_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/diagrams/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
}{}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\chapter{Modules Example}\label{modules_example}\hypertarget{modules_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/group/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Member Groups Example}\label{memgrp_example}\hypertarget{memgrp_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/memgrp/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{After Block Example}\label{afterdoc_example}\hypertarget{afterdoc_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/afterdoc/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{QT Style Example}\label{qtstyle_example}\hypertarget{qtstyle_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/qtstyle/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Javadoc Style Example}\label{jdstyle_example}\hypertarget{jdstyle_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/jdstyle/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Structural Commands Example}\label{structcmd_example}\hypertarget{structcmd_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/structcmd/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Python Docstring Example}\label{python_example}\hypertarget{python_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/docstring/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Python Example}\label{py_example}\hypertarget{py_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/pyexample/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{VHDL Example}\label{vhdl_example}\hypertarget{vhdl_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/mux/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Tcl Example}\label{tcl_example}\hypertarget{tcl_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/tclexample/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\chapter{Class Example}\label{class_example}\hypertarget{class_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/class/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Define Example}\label{define_example}\hypertarget{define_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/define/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Enum Example}\label{enum_example}\hypertarget{enum_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/enum/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Example Example}\label{example_example}\hypertarget{example_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/example/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Extends/Implements Example}\label{extends_example}\hypertarget{extends_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/manual/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{File Example}\label{file_example}\hypertarget{file_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/file/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Fn Example}\label{fn_example}\hypertarget{fn_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/func/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Overload Example}\label{overload_example}\hypertarget{overload_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/overload/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Page Example}\label{page_example}\hypertarget{page_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/page/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Relates Example}\label{relates_example}\hypertarget{relates_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/relates/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Author Example}\label{author_example}\hypertarget{author_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/author/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Par Example}\label{par_example}\hypertarget{par_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/par/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
\chapter{Include Example}\label{include_example}\hypertarget{include_example}{}
|
|
Packit |
1c1d7e |
\subinputfrom{../html/examples/include/latex/}{refman_doc}
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
\printindex
|
|
Packit |
1c1d7e |
\end{document}
|