aboutsummaryrefslogtreecommitdiffstats
path: root/doc/latex/doxygen.sty
diff options
context:
space:
mode:
Diffstat (limited to 'doc/latex/doxygen.sty')
-rw-r--r--doc/latex/doxygen.sty396
1 files changed, 188 insertions, 208 deletions
diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty
index 035aa63..199abf8 100644
--- a/doc/latex/doxygen.sty
+++ b/doc/latex/doxygen.sty
@@ -5,78 +5,43 @@
\RequirePackage{alltt}
\RequirePackage{array}
\RequirePackage{calc}
-\RequirePackage{color}
-\RequirePackage{fancyhdr}
-\RequirePackage{longtable}
-\RequirePackage{verbatim}
+\RequirePackage{float}
\RequirePackage{ifthen}
-\RequirePackage{xtab}
-\RequirePackage{multirow}
+\RequirePackage{verbatim}
\RequirePackage[table]{xcolor}
+\RequirePackage{xtab}
-% Use helvetica font instead of times roman
-\RequirePackage{helvet}
-\RequirePackage{sectsty}
-\RequirePackage{tocloft}
-\providecommand{\rmdefault}{phv}
-\providecommand{\bfdefault}{bc}
-
-
-% Setup fancy headings
-\pagestyle{fancyplain}
-\newcommand{\clearemptydoublepage}{%
- \newpage{\pagestyle{empty}\cleardoublepage}%
-}
-\renewcommand{\chaptermark}[1]{%
- \markboth{#1}{}%
-}
-\renewcommand{\sectionmark}[1]{%
- \markright{\thesection\ #1}%
-}
-\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
-\fancyhead[CE]{\fancyplain{}{}}
-\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
-\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
-\fancyhead[CO]{\fancyplain{}{}}
-\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
-\fancyfoot[LE]{\fancyplain{}{}}
-\fancyfoot[CE]{\fancyplain{}{}}
-\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Jun 6 2014 17\-:51\-:46 for Templates -\/-\/ Meow by Doxygen }}
-\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Jun 6 2014 17\-:51\-:46 for Templates -\/-\/ Meow by Doxygen }}
-\fancyfoot[CO]{\fancyplain{}{}}
-\fancyfoot[RO]{\fancyplain{}{}}
%---------- Internal commands used in this style file ----------------
-\newcommand\tabfill[1]{%
- \dimen@\linewidth%
- \advance\dimen@\@totalleftmargin%
- \advance\dimen@-\dimen\@curtab%
- \parbox[t]\dimen@{\raggedright #1\ifhmode\strut\fi}%
-}
-
\newcommand{\ensurespace}[1]{%
- \begingroup
+ \begingroup%
\setlength{\dimen@}{#1}%
- \vskip\z@\@plus\dimen@
- \penalty -100\vskip\z@\@plus -\dimen@
- \vskip\dimen@
+ \vskip\z@\@plus\dimen@%
+ \penalty -100\vskip\z@\@plus -\dimen@%
+ \vskip\dimen@%
\penalty 9999%
- \vskip -\dimen@
- \vskip\z@skip % hide the previous |\vskip| from |\addvspace|
- \endgroup
+ \vskip -\dimen@%
+ \vskip\z@skip% hide the previous |\vskip| from |\addvspace|
+ \endgroup%
+}
+
+\newcommand{\DoxyLabelFont}{}
+\newcommand{\entrylabel}[1]{%
+ {%
+ \parbox[b]{\labelwidth-4pt}{%
+ \makebox[0pt][l]{\DoxyLabelFont#1}%
+ \vspace{1.5\baselineskip}%
+ }%
+ }%
}
-% Generic environment used by all paragraph-based environments defined
-% below. Note that the command \title{...} needs to be defined inside
-% those environments!
\newenvironment{DoxyDesc}[1]{%
\ensurespace{4\baselineskip}%
- \begin{list}{}%
- {%
- \settowidth{\labelwidth}{40pt}%
- \setlength{\leftmargin}{\labelwidth}%
+ \begin{list}{}{%
+ \settowidth{\labelwidth}{20pt}%
\setlength{\parsep}{0pt}%
- \setlength{\itemsep}{-4pt}%
+ \setlength{\itemsep}{0pt}%
+ \setlength{\leftmargin}{\labelwidth+\labelsep}%
\renewcommand{\makelabel}{\entrylabel}%
}%
\item[#1]%
@@ -84,6 +49,21 @@
\end{list}%
}
+\newsavebox{\xrefbox}
+\newlength{\xreflength}
+\newcommand{\xreflabel}[1]{%
+ \sbox{\xrefbox}{#1}%
+ \setlength{\xreflength}{\wd\xrefbox}%
+ \ifthenelse{\xreflength>\labelwidth}{%
+ \begin{minipage}{\textwidth}%
+ \setlength{\parindent}{0pt}%
+ \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
+ \end{minipage}%
+ }{%
+ \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
+ }%
+}
+
%---------- Commands used by doxygen LaTeX output generator ----------
% Used by <pre> ... </pre>
@@ -97,11 +77,12 @@
% Used by @code ... @endcode
\newenvironment{DoxyCode}{%
-
-
-\begin{scriptsize}\begin{alltt}%
+ \par%
+ \scriptsize%
+ \begin{alltt}%
}{%
-\end{alltt}\end{scriptsize}%
+ \end{alltt}%
+ \normalsize%
}
% Used by @example, @include, @includelineno and @dontinclude
@@ -148,13 +129,13 @@
\enddescription%
}
-% Used by @image, @dotfile, and @dot ... @enddot
+% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
% (only if caption is specified)
\newenvironment{DoxyImage}{%
\begin{figure}[H]%
- \begin{center}%
+ \begin{center}%
}{%
- \end{center}%
+ \end{center}%
\end{figure}%
}
@@ -227,7 +208,7 @@
\end{DoxyDesc}%
}
-% Used by @return
+% Used by @return and @returns
\newenvironment{DoxyReturn}[1]{%
\begin{DoxyDesc}{#1}%
}{%
@@ -270,8 +251,7 @@
% Used by @par and @paragraph
\newenvironment{DoxyParagraph}[1]{%
- \begin{list}{}%
- {%
+ \begin{list}{}{%
\settowidth{\labelwidth}{40pt}%
\setlength{\leftmargin}{\labelwidth}%
\setlength{\parsep}{0pt}%
@@ -285,192 +265,192 @@
% Used by parameter lists
\newenvironment{DoxyParams}[2][]{%
- \begin{DoxyDesc}{#2}%
- \item[] \hspace{\fill} \vspace{-40pt}%
- \settowidth{\labelwidth}{40pt}%
- \setlength{\LTleft}{0pt}%
- \setlength{\tabcolsep}{0.01\textwidth}%
+ \par%
+ \tabletail{\hline}%
+ \tablelasttail{\hline}%
+ \tablefirsthead{}%
+ \tablehead{}%
\ifthenelse{\equal{#1}{}}%
- {\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
- p{0.815\textwidth}|}}%
+ {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
+ \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ p{0.805\textwidth}|}}%
{\ifthenelse{\equal{#1}{1}}%
- {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
+ {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
+ \begin{xtabular}{|>{\centering}p{0.10\textwidth}|%
>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
- p{0.685\textwidth}|}}%
- {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
+ p{0.678\textwidth}|}}%
+ {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}%
+ \begin{xtabular}{|>{\centering}p{0.10\textwidth}|%
>{\centering\hspace{0pt}}p{0.15\textwidth}|%
>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
- p{0.515\textwidth}|}}%
+ p{0.501\textwidth}|}}%
}\hline%
}{%
- \end{longtable}%
- \end{DoxyDesc}%
+ \end{xtabular}%
+ \tablefirsthead{}%
+ \vspace{6pt}%
}
% Used for fields of simple structs
\newenvironment{DoxyFields}[1]{%
- \begin{DoxyDesc}{#1}%
- \item[] \hspace{\fill} \vspace{-40pt}%
- \settowidth{\labelwidth}{40pt}%
- \setlength{\LTleft}{0pt}%
- \setlength{\tabcolsep}{0.01\textwidth}%
- \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
+ \par%
+ \tabletail{\hline}%
+ \tablelasttail{\hline}%
+ \tablehead{}%
+ \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
+ \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
p{0.15\textwidth}|%
- p{0.635\textwidth}|}%
+ p{0.63\textwidth}|}%
\hline%
}{%
- \end{longtable}%
- \end{DoxyDesc}%
+ \end{xtabular}%
+ \tablefirsthead{}%
+ \vspace{6pt}%
}
-% is used for parameters within a detailed function description
+% Used for parameters within a detailed function description
\newenvironment{DoxyParamCaption}{%
\renewcommand{\item}[2][]{##1 {\em ##2}}%
- }{%
+}{%
}
% Used by return value lists
\newenvironment{DoxyRetVals}[1]{%
- \begin{DoxyDesc}{#1}%
- \begin{description}%
- \item[] \hspace{\fill} \vspace{-25pt}%
- \setlength{\tabcolsep}{0.01\textwidth}%
- \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ \par%
+ \tabletail{\hline}%
+ \tablelasttail{\hline}%
+ \tablehead{}%
+ \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
+ \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
p{0.705\textwidth}|}%
- \hline%
+ \hline%
}{%
- \end{longtable}%
- \end{description}%
- \end{DoxyDesc}%
+ \end{xtabular}%
+ \tablefirsthead{}%
+ \vspace{6pt}%
}
% Used by exception lists
\newenvironment{DoxyExceptions}[1]{%
- \begin{DoxyDesc}{#1}%
- \begin{description}%
- \item[] \hspace{\fill} \vspace{-25pt}%
- \definecolor{tableShade}{HTML}{F8F8F8}%
- \rowcolors{1}{white}{tableShade}%
- \arrayrulecolor{gray}%
- \setlength{\tabcolsep}{0.01\textwidth}%
- \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ \par%
+ \tabletail{\hline}%
+ \tablelasttail{\hline}%
+ \tablehead{}%
+ \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
+ \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
p{0.705\textwidth}|}%
- \hline%
+ \hline%
}{%
- \end{longtable}%
- \end{description}%
- \end{DoxyDesc}%
+ \end{xtabular}%
+ \tablefirsthead{}%
+ \vspace{6pt}%
}
% Used by template parameter lists
\newenvironment{DoxyTemplParams}[1]{%
- \begin{DoxyDesc}{#1}%
- \begin{description}%
- \item[] \hspace{\fill} \vspace{-25pt}%
- \definecolor{tableShade}{HTML}{F8F8F8}%
- \rowcolors{1}{white}{tableShade}%
- \arrayrulecolor{gray}%
- \setlength{\tabcolsep}{0.01\textwidth}%
- \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
+ \par%
+ \tabletail{\hline}%
+ \tablelasttail{\hline}%
+ \tablehead{}%
+ \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}%
+ \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
p{0.705\textwidth}|}%
- \hline%
+ \hline%
}{%
- \end{longtable}%
- \end{description}%
- \end{DoxyDesc}%
+ \end{xtabular}%
+ \tablefirsthead{}%
+ \vspace{6pt}%
}
-\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
-\newenvironment{DoxyCompactList}
-{\begin{list}{}{
- \setlength{\leftmargin}{0.5cm}
- \setlength{\itemsep}{0pt}
- \setlength{\parsep}{0pt}
- \setlength{\topsep}{0pt}
- \renewcommand{\makelabel}{\hfill}}}
-{\end{list}}
-\newenvironment{DoxyCompactItemize}
-{
- \begin{itemize}
- \setlength{\itemsep}{-3pt}
- \setlength{\parsep}{0pt}
- \setlength{\topsep}{0pt}
- \setlength{\partopsep}{0pt}
-}
-{\end{itemize}}
-\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
-\newlength{\tmplength}
-\newenvironment{TabularC}[1]
-{
-\setlength{\tmplength}
- {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
- \par\begin{xtabular*}{\linewidth}
- {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
-}
-{\end{xtabular*}\par}
-\newcommand{\entrylabel}[1]{
- {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{%
- \usefont{OT1}{phv}{bc}{n}\color{darkgray}#1}\vspace{1.5\baselineskip}}}}
-\newenvironment{Desc}
-{\begin{list}{}
- {
- \settowidth{\labelwidth}{40pt}
- \setlength{\leftmargin}{\labelwidth}
- \setlength{\parsep}{0pt}
- \setlength{\itemsep}{-4pt}
- \renewcommand{\makelabel}{\entrylabel}
- }
+% Used for member lists
+\newenvironment{DoxyCompactItemize}{%
+ \begin{itemize}%
+ \setlength{\itemsep}{-3pt}%
+ \setlength{\parsep}{0pt}%
+ \setlength{\topsep}{0pt}%
+ \setlength{\partopsep}{0pt}%
+}{%
+ \end{itemize}%
}
-{\end{list}}
-\newsavebox{\xrefbox}
-\newlength{\xreflength}
-\newcommand{\xreflabel}[1]{%
- \sbox{\xrefbox}{#1}%
- \setlength{\xreflength}{\wd\xrefbox}%
- \ifthenelse{\xreflength>\labelwidth}{%
- \begin{minipage}{\textwidth}%
- \setlength{\parindent}{0pt}%
- \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
- \end{minipage}%
- }{%
- \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
- }}%
+
+% Used for member descriptions
+\newenvironment{DoxyCompactList}{%
+ \begin{list}{}{%
+ \setlength{\leftmargin}{0.5cm}%
+ \setlength{\itemsep}{0pt}%
+ \setlength{\parsep}{0pt}%
+ \setlength{\topsep}{0pt}%
+ \renewcommand{\makelabel}{\hfill}%
+ }%
+}{%
+ \end{list}%
+}
+
+% Used for reference lists (@bug, @deprecated, @todo, etc.)
\newenvironment{DoxyRefList}{%
\begin{list}{}{%
\setlength{\labelwidth}{10pt}%
\setlength{\leftmargin}{\labelwidth}%
\addtolength{\leftmargin}{\labelsep}%
\renewcommand{\makelabel}{\xreflabel}%
- }%
}%
-{\end{list}}
-\newenvironment{DoxyRefDesc}[1]
+}{%
+ \end{list}%
+}
+
+% Used by @bug, @deprecated, @todo, etc.
+\newenvironment{DoxyRefDesc}[1]{%
+ \begin{list}{}{%
+ \renewcommand\makelabel[1]{\textbf{##1}}%
+ \settowidth\labelwidth{\makelabel{#1}}%
+ \setlength\leftmargin{\labelwidth+\labelsep}%
+ }%
+}{%
+ \end{list}%
+}
+
+% Used by parameter lists and simple sections
+\newenvironment{Desc}
{\begin{list}{}{%
- \renewcommand\makelabel[1]{\textbf{##1}}
- \settowidth\labelwidth{\makelabel{#1}}
- \setlength\leftmargin{\labelwidth+\labelsep}}}
-{\end{list}}
-\newenvironment{Indent}
- {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
- \item[]\ignorespaces}
- {\unskip\end{list}}
-\setlength{\parindent}{0cm}
-\setlength{\parskip}{0.2cm}
-\addtocounter{secnumdepth}{2}
-\usepackage[T1]{fontenc}
-\makeatletter
-\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
- {-1.0ex}%
- {1.0ex}%
- {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
-\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{0ex}%
- {-1.0ex}%
- {1.0ex}%
- {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
-\makeatother
-\allsectionsfont{\usefont{OT1}{phv}{bc}{n}\selectfont\color{darkgray}}
-\stepcounter{secnumdepth}
-\stepcounter{tocdepth}
+ \settowidth{\labelwidth}{40pt}%
+ \setlength{\leftmargin}{\labelwidth}%
+ \setlength{\parsep}{0pt}%
+ \setlength{\itemsep}{-4pt}%
+ \renewcommand{\makelabel}{\entrylabel}%
+ }
+}{%
+ \end{list}%
+}
+
+% Used by tables
+\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
+\newlength{\tmplength}%
+\newenvironment{TabularC}[1]%
+{%
+\setlength{\tmplength}%
+ {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}%
+ \par\begin{xtabular*}{\linewidth}%
+ {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}%
+}%
+{\end{xtabular*}\par}%
+
+% Used for member group headers
+\newenvironment{Indent}{%
+ \begin{list}{}{%
+ \setlength{\leftmargin}{0.5cm}%
+ }%
+ \item[]\ignorespaces%
+}{%
+ \unskip%
+ \end{list}%
+}
+
+% Used when hyperlinks are turned off
+\newcommand{\doxyref}[3]{%
+ \textbf{#1} (\textnormal{#2}\,\pageref{#3})%
+}
+
+% Used for syntax highlighting
\definecolor{comment}{rgb}{0.5,0.0,0.0}
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}