123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480 |
- \NeedsTeXFormat{LaTeX2e}
- \ProvidesPackage{doxygen}
-
- % Packages used by this style file
- \RequirePackage{alltt}
- \RequirePackage{array}
- \RequirePackage{calc}
- \RequirePackage{float}
- \RequirePackage{ifthen}
- \RequirePackage{verbatim}
- \RequirePackage[table]{xcolor}
- \RequirePackage{xtab}
-
- %---------- Internal commands used in this style file ----------------
-
- \newcommand{\ensurespace}[1]{%
- \begingroup%
- \setlength{\dimen@}{#1}%
- \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%
- }
-
- \newcommand{\DoxyLabelFont}{}
- \newcommand{\entrylabel}[1]{%
- {%
- \parbox[b]{\labelwidth-4pt}{%
- \makebox[0pt][l]{\DoxyLabelFont#1}%
- \vspace{1.5\baselineskip}%
- }%
- }%
- }
-
- \newenvironment{DoxyDesc}[1]{%
- \ensurespace{4\baselineskip}%
- \begin{list}{}{%
- \settowidth{\labelwidth}{20pt}%
- \setlength{\parsep}{0pt}%
- \setlength{\itemsep}{0pt}%
- \setlength{\leftmargin}{\labelwidth+\labelsep}%
- \renewcommand{\makelabel}{\entrylabel}%
- }%
- \item[#1]%
- }{%
- \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>
- \newenvironment{DoxyPre}{%
- \small%
- \begin{alltt}%
- }{%
- \end{alltt}%
- \normalsize%
- }
-
- % Used by @code ... @endcode
- \newenvironment{DoxyCode}{%
- \par%
- \scriptsize%
- \begin{alltt}%
- }{%
- \end{alltt}%
- \normalsize%
- }
-
- % Used by @example, @include, @includelineno and @dontinclude
- \newenvironment{DoxyCodeInclude}{%
- \DoxyCode%
- }{%
- \endDoxyCode%
- }
-
- % Used by @verbatim ... @endverbatim
- \newenvironment{DoxyVerb}{%
- \footnotesize%
- \verbatim%
- }{%
- \endverbatim%
- \normalsize%
- }
-
- % Used by @verbinclude
- \newenvironment{DoxyVerbInclude}{%
- \DoxyVerb%
- }{%
- \endDoxyVerb%
- }
-
- % Used by numbered lists (using '-#' or <ol> ... </ol>)
- \newenvironment{DoxyEnumerate}{%
- \enumerate%
- }{%
- \endenumerate%
- }
-
- % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
- \newenvironment{DoxyItemize}{%
- \itemize%
- }{%
- \enditemize%
- }
-
- % Used by description lists (using <dl> ... </dl>)
- \newenvironment{DoxyDescription}{%
- \description%
- }{%
- \enddescription%
- }
-
- % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
- % (only if caption is specified)
- \newenvironment{DoxyImage}{%
- \begin{figure}[H]%
- \begin{center}%
- }{%
- \end{center}%
- \end{figure}%
- }
-
- % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
- % (only if no caption is specified)
- \newenvironment{DoxyImageNoCaption}{%
- \begin{center}%
- }{%
- \end{center}%
- }
-
- % Used by @attention
- \newenvironment{DoxyAttention}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @author and @authors
- \newenvironment{DoxyAuthor}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @date
- \newenvironment{DoxyDate}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @invariant
- \newenvironment{DoxyInvariant}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @note
- \newenvironment{DoxyNote}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @post
- \newenvironment{DoxyPostcond}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @pre
- \newenvironment{DoxyPrecond}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @copyright
- \newenvironment{DoxyCopyright}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @remark
- \newenvironment{DoxyRemark}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @return and @returns
- \newenvironment{DoxyReturn}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @since
- \newenvironment{DoxySince}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @see
- \newenvironment{DoxySeeAlso}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @version
- \newenvironment{DoxyVersion}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @warning
- \newenvironment{DoxyWarning}[1]{%
- \begin{DoxyDesc}{#1}%
- }{%
- \end{DoxyDesc}%
- }
-
- % Used by @internal
- \newenvironment{DoxyInternal}[1]{%
- \paragraph*{#1}%
- }{%
- }
-
- % Used by @par and @paragraph
- \newenvironment{DoxyParagraph}[1]{%
- \begin{list}{}{%
- \settowidth{\labelwidth}{40pt}%
- \setlength{\leftmargin}{\labelwidth}%
- \setlength{\parsep}{0pt}%
- \setlength{\itemsep}{-4pt}%
- \renewcommand{\makelabel}{\entrylabel}%
- }%
- \item[#1]%
- }{%
- \end{list}%
- }
-
- % Used by parameter lists
- \newenvironment{DoxyParams}[2][]{%
- \par%
- \tabletail{\hline}%
- \tablelasttail{\hline}%
- \tablefirsthead{}%
- \tablehead{}%
- \ifthenelse{\equal{#1}{}}%
- {\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}}%
- {\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.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.501\textwidth}|}}%
- }\hline%
- }{%
- \end{xtabular}%
- \tablefirsthead{}%
- \vspace{6pt}%
- }
-
- % Used for fields of simple structs
- \newenvironment{DoxyFields}[1]{%
- \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.63\textwidth}|}%
- \hline%
- }{%
- \end{xtabular}%
- \tablefirsthead{}%
- \vspace{6pt}%
- }
-
- % Used for parameters within a detailed function description
- \newenvironment{DoxyParamCaption}{%
- \renewcommand{\item}[2][]{##1 {\em ##2}}%
- }{%
- }
-
- % Used by return value lists
- \newenvironment{DoxyRetVals}[1]{%
- \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%
- }{%
- \end{xtabular}%
- \tablefirsthead{}%
- \vspace{6pt}%
- }
-
- % Used by exception lists
- \newenvironment{DoxyExceptions}[1]{%
- \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%
- }{%
- \end{xtabular}%
- \tablefirsthead{}%
- \vspace{6pt}%
- }
-
- % Used by template parameter lists
- \newenvironment{DoxyTemplParams}[1]{%
- \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%
- }{%
- \end{xtabular}%
- \tablefirsthead{}%
- \vspace{6pt}%
- }
-
- % Used for member lists
- \newenvironment{DoxyCompactItemize}{%
- \begin{itemize}%
- \setlength{\itemsep}{-3pt}%
- \setlength{\parsep}{0pt}%
- \setlength{\topsep}{0pt}%
- \setlength{\partopsep}{0pt}%
- }{%
- \end{itemize}%
- }
-
- % 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}%
- }
-
- % 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}{}{%
- \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 by nested tables
- \newenvironment{TabularNC}[1]%
- {%
- \setlength{\tmplength}%
- {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}%
- \par\begin{tabular*}{\linewidth}%
- {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}%
- }%
- {\end{tabular*}\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 by @addindex
- \newcommand{\lcurly}{\{}
- \newcommand{\rcurly}{\}}
-
- % 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}
- \definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
- \definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
- \definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
- \definecolor{charliteral}{rgb}{0.0,0.5,0.5}
- \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
- \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
- \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
- \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
|