Blame doc/liboggz/latex/doxygen.sty

Packit a38265
\NeedsTeXFormat{LaTeX2e}
Packit a38265
\ProvidesPackage{doxygen}
Packit a38265
Packit a38265
% Packages used by this style file
Packit a38265
\RequirePackage{alltt}
Packit a38265
\RequirePackage{array}
Packit a38265
\RequirePackage{calc}
Packit a38265
\RequirePackage{color}
Packit a38265
\RequirePackage{fancyhdr}
Packit a38265
\RequirePackage{verbatim}
Packit a38265
Packit a38265
% Setup fancy headings
Packit a38265
\pagestyle{fancyplain}
Packit a38265
\newcommand{\clearemptydoublepage}{%
Packit a38265
  \newpage{\pagestyle{empty}\cleardoublepage}%
Packit a38265
}
Packit a38265
\renewcommand{\chaptermark}[1]{%
Packit a38265
  \markboth{#1}{}%
Packit a38265
}
Packit a38265
\renewcommand{\sectionmark}[1]{%
Packit a38265
  \markright{\thesection\ #1}%
Packit a38265
}
Packit a38265
\lhead[\fancyplain{}{\bfseries\thepage}]{%
Packit a38265
  \fancyplain{}{\bfseries\rightmark}%
Packit a38265
}
Packit a38265
\rhead[\fancyplain{}{\bfseries\leftmark}]{%
Packit a38265
  \fancyplain{}{\bfseries\thepage}%
Packit a38265
}
Packit a38265
\rfoot[\fancyplain{}{\bfseries\scriptsize%
Packit a38265
  Generated on Sat Apr 24 09:13:55 2010 for liboggz by Doxygen }]{}
Packit a38265
\lfoot[]{\fancyplain{}{\bfseries\scriptsize%
Packit a38265
  Generated on Sat Apr 24 09:13:55 2010 for liboggz by Doxygen }}
Packit a38265
\cfoot{}
Packit a38265
Packit a38265
%---------- Internal commands used in this style file ----------------
Packit a38265
Packit a38265
% Generic environment used by all paragraph-based environments defined
Packit a38265
% below. Note that the command \title{...} needs to be defined inside
Packit a38265
% those environments!
Packit a38265
\newenvironment{DoxyDesc}[1]{%
Packit a38265
  \begin{list}{}%
Packit a38265
  {%
Packit a38265
    \settowidth{\labelwidth}{40pt}%
Packit a38265
    \setlength{\leftmargin}{\labelwidth}%
Packit a38265
    \setlength{\parsep}{0pt}%
Packit a38265
    \setlength{\itemsep}{-4pt}%
Packit a38265
    \renewcommand{\makelabel}{\entrylabel}%
Packit a38265
  }%
Packit a38265
  \item[#1]%
Packit a38265
}{%
Packit a38265
  \end{list}%
Packit a38265
}
Packit a38265
Packit a38265
%---------- Commands used by doxygen LaTeX output generator ----------
Packit a38265
Packit a38265
% Used by 
 ... 
Packit a38265
\newenvironment{DoxyPre}{%
Packit a38265
  \small%
Packit a38265
  \begin{alltt}%
Packit a38265
}{%
Packit a38265
  \end{alltt}%
Packit a38265
  \normalsize%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @code ... @endcode
Packit a38265
\newenvironment{DoxyCode}{%
Packit a38265
  \footnotesize%
Packit a38265
  \verbatim%
Packit a38265
}{%
Packit a38265
  \endverbatim%
Packit a38265
  \normalsize%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @example, @include, @includelineno and @dontinclude
Packit a38265
\newenvironment{DoxyCodeInclude}{%
Packit a38265
  \DoxyCode%
Packit a38265
}{%
Packit a38265
  \endDoxyCode%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @verbatim ... @endverbatim
Packit a38265
\newenvironment{DoxyVerb}{%
Packit a38265
  \footnotesize%
Packit a38265
  \verbatim%
Packit a38265
}{%
Packit a38265
  \endverbatim%
Packit a38265
  \normalsize%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @verbinclude
Packit a38265
\newenvironment{DoxyVerbInclude}{%
Packit a38265
  \DoxyVerb%
Packit a38265
}{%
Packit a38265
  \endDoxyVerb%
Packit a38265
}
Packit a38265
Packit a38265
% Used by numbered lists (using '-#' or 
    ...
)
Packit a38265
\newenvironment{DoxyEnumerate}{%
Packit a38265
  \enumerate%
Packit a38265
}{%
Packit a38265
  \endenumerate%
Packit a38265
}
Packit a38265
Packit a38265
% Used by bullet lists (using '-', @li, @arg, or 
    ...
)
Packit a38265
\newenvironment{DoxyItemize}{%
Packit a38265
  \itemize%
Packit a38265
}{%
Packit a38265
  \enditemize%
Packit a38265
}
Packit a38265
Packit a38265
% Used by description lists (using 
...
)
Packit a38265
\newenvironment{DoxyDescription}{%
Packit a38265
  \description%
Packit a38265
}{%
Packit a38265
  \enddescription%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @image, @dotfile, and @dot ... @enddot
Packit a38265
% (only if caption is specified)
Packit a38265
\newenvironment{DoxyImage}{%
Packit a38265
  \begin{figure}[H]%
Packit a38265
  \begin{center}%
Packit a38265
}{%
Packit a38265
  \end{center}%
Packit a38265
  \end{figure}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
Packit a38265
% (only if no caption is specified)
Packit a38265
\newenvironment{DoxyImageNoCaption}{%
Packit a38265
}{%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @attention
Packit a38265
\newenvironment{DoxyAttention}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @author and @authors
Packit a38265
\newenvironment{DoxyAuthor}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @date
Packit a38265
\newenvironment{DoxyDate}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @invariant
Packit a38265
\newenvironment{DoxyInvariant}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @note
Packit a38265
\newenvironment{DoxyNote}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @post
Packit a38265
\newenvironment{DoxyPostcond}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @pre
Packit a38265
\newenvironment{DoxyPrecond}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @remark
Packit a38265
\newenvironment{DoxyRemark}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @return
Packit a38265
\newenvironment{DoxyReturn}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @since
Packit a38265
\newenvironment{DoxySince}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @see
Packit a38265
\newenvironment{DoxySeeAlso}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @version
Packit a38265
\newenvironment{DoxyVersion}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @warning
Packit a38265
\newenvironment{DoxyWarning}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
}{%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @internal
Packit a38265
\newenvironment{DoxyInternal}[1]{%
Packit a38265
  \paragraph*{#1}%
Packit a38265
}{%
Packit a38265
}
Packit a38265
Packit a38265
% Used by @par and @paragraph
Packit a38265
\newenvironment{DoxyParagraph}[1]{%
Packit a38265
  \begin{list}{}%
Packit a38265
  {%
Packit a38265
    \settowidth{\labelwidth}{40pt}%
Packit a38265
    \setlength{\leftmargin}{\labelwidth}%
Packit a38265
    \setlength{\parsep}{0pt}%
Packit a38265
    \setlength{\itemsep}{-4pt}%
Packit a38265
    \renewcommand{\makelabel}{\entrylabel}%
Packit a38265
  }%
Packit a38265
  \item[#1]%
Packit a38265
}{%
Packit a38265
  \end{list}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by parameter lists
Packit a38265
\newenvironment{DoxyParams}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
    \begin{description}%
Packit a38265
}{%
Packit a38265
    \end{description}%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by return value lists
Packit a38265
\newenvironment{DoxyRetVals}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
    \begin{description}%
Packit a38265
}{%
Packit a38265
    \end{description}%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by exception lists
Packit a38265
\newenvironment{DoxyExceptions}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
    \begin{description}%
Packit a38265
}{%
Packit a38265
    \end{description}%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
% Used by template parameter lists
Packit a38265
\newenvironment{DoxyTemplParams}[1]{%
Packit a38265
  \begin{DoxyDesc}{#1}%
Packit a38265
    \begin{description}%
Packit a38265
}{%
Packit a38265
    \end{description}%
Packit a38265
  \end{DoxyDesc}%
Packit a38265
}
Packit a38265
Packit a38265
\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
Packit a38265
\newenvironment{DoxyCompactList}
Packit a38265
{\begin{list}{}{
Packit a38265
  \setlength{\leftmargin}{0.5cm}
Packit a38265
  \setlength{\itemsep}{0pt}
Packit a38265
  \setlength{\parsep}{0pt}
Packit a38265
  \setlength{\topsep}{0pt}
Packit a38265
  \renewcommand{\makelabel}{\hfill}}}
Packit a38265
{\end{list}}
Packit a38265
\newenvironment{DoxyCompactItemize}
Packit a38265
{
Packit a38265
  \begin{itemize}
Packit a38265
  \setlength{\itemsep}{-3pt}
Packit a38265
  \setlength{\parsep}{0pt}
Packit a38265
  \setlength{\topsep}{0pt}
Packit a38265
  \setlength{\partopsep}{0pt}
Packit a38265
}
Packit a38265
{\end{itemize}}
Packit a38265
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
Packit a38265
\newlength{\tmplength}
Packit a38265
\newenvironment{TabularC}[1]
Packit a38265
{
Packit a38265
\setlength{\tmplength}
Packit a38265
     {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
Packit a38265
      \par\begin{tabular*}{\linewidth}
Packit a38265
             {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
Packit a38265
}
Packit a38265
{\end{tabular*}\par}
Packit a38265
\newcommand{\entrylabel}[1]{
Packit a38265
   {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
Packit a38265
\newenvironment{Desc}
Packit a38265
{\begin{list}{}
Packit a38265
  {
Packit a38265
    \settowidth{\labelwidth}{40pt}
Packit a38265
    \setlength{\leftmargin}{\labelwidth}
Packit a38265
    \setlength{\parsep}{0pt}
Packit a38265
    \setlength{\itemsep}{-4pt}
Packit a38265
    \renewcommand{\makelabel}{\entrylabel}
Packit a38265
  }
Packit a38265
}
Packit a38265
{\end{list}}
Packit a38265
\newenvironment{Indent}
Packit a38265
  {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
Packit a38265
      \item[]\ignorespaces}
Packit a38265
  {\unskip\end{list}}
Packit a38265
\setlength{\parindent}{0cm}
Packit a38265
\setlength{\parskip}{0.2cm}
Packit a38265
\addtocounter{secnumdepth}{1}
Packit a38265
\sloppy
Packit a38265
\usepackage[T1]{fontenc}
Packit a38265
\makeatletter
Packit a38265
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
Packit a38265
   {-3.25ex plus -1ex minus -0.2ex}%
Packit a38265
   {1.5ex plus 0.2ex}%
Packit a38265
   {\normalfont\normalsize\bfseries}}
Packit a38265
\makeatother
Packit a38265
\stepcounter{secnumdepth}
Packit a38265
\stepcounter{tocdepth}
Packit a38265
\definecolor{comment}{rgb}{0.5,0.0,0.0}
Packit a38265
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
Packit a38265
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
Packit a38265
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
Packit a38265
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
Packit a38265
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
Packit a38265
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
Packit a38265
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
Packit a38265
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
Packit a38265
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
Packit a38265
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}