1 \NeedsTeXFormat{LaTeX2e
}
2 \ProvidesPackage{doxygen
}
4 % Packages used by this style file
5 % See: http://en.wikibooks.org/wiki/LaTeX/Page_Layout#Standard_page_styles
10 \RequirePackage{fancyhdr
}
11 \RequirePackage{longtable
}
12 \RequirePackage{verbatim
}
13 \RequirePackage{ifthen
}
14 \RequirePackage[table
]{xcolor
}
16 % Use helvetica font instead of times roman
17 \RequirePackage{helvet
}
18 \RequirePackage{sectsty
}
19 \RequirePackage{tocloft
}
20 \providecommand{\rmdefault}{phv
}
21 \providecommand{\bfdefault}{bc
}
24 % Setup fancy headings
25 \pagestyle{fancyplain
}
26 \newcommand{\clearemptydoublepage}{%
27 \newpage{\pagestyle{empty
}\cleardoublepage}%
29 \renewcommand{\chaptermark}[1]{%
32 \renewcommand{\sectionmark}[1]{%
33 \markright{\thesection\
#1}%
36 \fancyhead[RE
]{\fancyplain{}{\bfseries\leftmark}}
37 \fancyhead[CE
]{\fancyplain{}{}}
38 \fancyhead[LE
]{\fancyplain{}{\bfseries\thepage}}
39 \fancyhead[RO
]{\fancyplain{}{\bfseries\rightmark}}
40 \fancyhead[CO
]{\fancyplain{}{}}
41 \fancyhead[LO
]{\fancyplain{}{\bfseries\thepage}}
42 \fancyfoot[RE
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_DATE@
}}
43 \fancyfoot[LE
]{\fancyplain{}
44 {\ifthenelse{\equal{@DOXYGEN_LOGO@
}{}}{}
45 {\includegraphics[height=
20pt
]{@DOXYGEN_LOGO@
}}}}
46 \fancyfoot[CE
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_AUTHOR@
}}
47 \fancyfoot[RO
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_DATE@
}}
48 \fancyfoot[LO
]{\fancyplain{}
49 {\ifthenelse{\equal{@DOXYGEN_LOGO@
}{}}{}
50 {\includegraphics[height=
20pt
]{@DOXYGEN_LOGO@
}}}}
51 \fancyfoot[CO
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_AUTHOR@
}}
53 \fancypagestyle{plain
}{
54 \fancyhead[RE
]{\fancyplain{}{\bfseries\leftmark}}
55 \fancyhead[CE
]{\fancyplain{}{}}
56 \fancyhead[LE
]{\fancyplain{}{\bfseries\thepage}}
57 \fancyhead[RO
]{\fancyplain{}{\bfseries\rightmark}}
58 \fancyhead[CO
]{\fancyplain{}{}}
59 \fancyhead[LO
]{\fancyplain{}{\bfseries\thepage}}
60 \fancyfoot[RE
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_DATE@
}}
61 \fancyfoot[LE
]{\fancyplain{}
62 {\ifthenelse{\equal{@DOXYGEN_LOGO@
}{}}{}
63 {\includegraphics[height=
20pt
]{@DOXYGEN_LOGO@
}}}}
64 \fancyfoot[CE
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_AUTHOR@
}}
65 \fancyfoot[RO
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_DATE@
}}
66 \fancyfoot[LO
]{\fancyplain{}
67 {\ifthenelse{\equal{@DOXYGEN_LOGO@
}{}}{}
68 {\includegraphics[height=
20pt
]{@DOXYGEN_LOGO@
}}}}
69 \fancyfoot[CO
]{\fancyplain{}{\bfseries\scriptsize @DOXYGEN_AUTHOR@
}}}
71 %---------- Internal commands used in this style file ----------------
73 % Generic environment used by all paragraph-based environments defined
74 % below. Note that the command \title{...} needs to be defined inside
76 \newenvironment{DoxyDesc
}[1]{%
79 \settowidth{\labelwidth}{40pt
}%
80 \setlength{\leftmargin}{\labelwidth}%
81 \setlength{\parsep}{0pt
}%
82 \setlength{\itemsep}{-
4pt
}%
83 \renewcommand{\makelabel}{\entrylabel}%
90 %---------- Commands used by doxygen LaTeX output generator ----------
92 % Used by <pre> ... </pre>
93 \newenvironment{DoxyPre
}{%
101 % Used by @code ... @endcode
102 \newenvironment{DoxyCode
}{%
110 % Used by @example, @include, @includelineno and @dontinclude
111 \newenvironment{DoxyCodeInclude
}{%
117 % Used by @verbatim ... @endverbatim
118 \newenvironment{DoxyVerb
}{%
126 % Used by @verbinclude
127 \newenvironment{DoxyVerbInclude
}{%
133 % Used by numbered lists (using '-#' or <ol> ... </ol>)
134 \newenvironment{DoxyEnumerate
}{%
140 % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
141 \newenvironment{DoxyItemize
}{%
147 % Used by description lists (using <dl> ... </dl>)
148 \newenvironment{DoxyDescription
}{%
154 % Used by @image, @dotfile, and @dot ... @enddot
155 % (only if caption is specified)
156 \newenvironment{DoxyImage
}{%
164 % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
165 % (only if no caption is specified)
166 \newenvironment{DoxyImageNoCaption
}{%
171 \newenvironment{DoxyAttention
}[1]{%
172 \begin{DoxyDesc
}{#1}%
177 % Used by @author and @authors
178 \newenvironment{DoxyAuthor
}[1]{%
179 \begin{DoxyDesc
}{#1}%
185 \newenvironment{DoxyDate
}[1]{%
186 \begin{DoxyDesc
}{#1}%
192 \newenvironment{DoxyInvariant
}[1]{%
193 \begin{DoxyDesc
}{#1}%
199 \newenvironment{DoxyNote
}[1]{%
200 \begin{DoxyDesc
}{#1}%
206 \newenvironment{DoxyPostcond
}[1]{%
207 \begin{DoxyDesc
}{#1}%
213 \newenvironment{DoxyPrecond
}[1]{%
214 \begin{DoxyDesc
}{#1}%
220 \newenvironment{DoxyRemark
}[1]{%
221 \begin{DoxyDesc
}{#1}%
227 \newenvironment{DoxyReturn
}[1]{%
228 \begin{DoxyDesc
}{#1}%
234 \newenvironment{DoxySince
}[1]{%
235 \begin{DoxyDesc
}{#1}%
241 \newenvironment{DoxySeeAlso
}[1]{%
242 \begin{DoxyDesc
}{#1}%
248 \newenvironment{DoxyVersion
}[1]{%
249 \begin{DoxyDesc
}{#1}%
255 \newenvironment{DoxyWarning
}[1]{%
256 \begin{DoxyDesc
}{#1}%
262 \newenvironment{DoxyInternal
}[1]{%
267 % Used by @par and @paragraph
268 \newenvironment{DoxyParagraph
}[1]{%
271 \settowidth{\labelwidth}{40pt
}%
272 \setlength{\leftmargin}{\labelwidth}%
273 \setlength{\parsep}{0pt
}%
274 \setlength{\itemsep}{-
4pt
}%
275 \renewcommand{\makelabel}{\entrylabel}%
282 % Used by parameter lists
283 \newenvironment{DoxyParams
}[2][]{%
284 \begin{DoxyDesc
}{#2}%
286 \item[] \hspace{\fill} \vspace{-
25pt
}%
287 \definecolor{tableShade
}{HTML
}{F8F8F8
}%
288 \rowcolors{1}{white
}{tableShade
}%
289 \arrayrulecolor{gray
}%
290 \setlength{\tabcolsep}{0.01\textwidth}%
291 \ifthenelse{\equal{#1}{}}
292 {\begin{longtable
}{|>
{\raggedleft\hspace{0pt
}}p
{0.15\textwidth}|
%
293 p
{0.79\textwidth}|
}}%
294 {\ifthenelse{\equal{#1}{1}}%
295 {\begin{longtable
}{|>
{\centering}p
{0.10\textwidth}|
%
296 >
{\raggedleft\hspace{0pt
}}p
{0.15\textwidth}|
%
297 p
{0.68\textwidth}|
}}%
298 {\begin{longtable
}{|>
{\centering}p
{0.10\textwidth}|
%
299 >
{\centering\hspace{0pt
}}p
{0.15\textwidth}|
%
300 >
{\raggedleft\hspace{0pt
}}p
{0.15\textwidth}|
%
301 p
{0.50\textwidth}|
}}%
309 % is used for parameters within a detailed function description
310 \newenvironment{DoxyParamCaption
}{%
311 \renewcommand{\item}[2][]{#
#1 {\em #
#2}}%
315 % Used by return value lists
316 \newenvironment{DoxyRetVals
}[1]{%
317 \begin{DoxyDesc
}{#1}%
319 \item[] \hspace{\fill} \vspace{-
25pt
}%
320 \definecolor{tableShade
}{HTML
}{F8F8F8
}%
321 \rowcolors{1}{white
}{tableShade
}%
322 \arrayrulecolor{gray
}%
323 \setlength{\tabcolsep}{0.01\textwidth}%
324 \begin{longtable
}{|>
{\raggedleft\hspace{0pt
}}p
{0.25\textwidth}|
%
333 % Used by exception lists
334 \newenvironment{DoxyExceptions
}[1]{%
335 \begin{DoxyDesc
}{#1}%
337 \item[] \hspace{\fill} \vspace{-
25pt
}%
338 \definecolor{tableShade
}{HTML
}{F8F8F8
}%
339 \rowcolors{1}{white
}{tableShade
}%
340 \arrayrulecolor{gray
}%
341 \setlength{\tabcolsep}{0.01\textwidth}%
342 \begin{longtable
}{|>
{\raggedleft\hspace{0pt
}}p
{0.25\textwidth}|
%
351 % Used by template parameter lists
352 \newenvironment{DoxyTemplParams
}[1]{%
353 \begin{DoxyDesc
}{#1}%
355 \item[] \hspace{\fill} \vspace{-
25pt
}%
356 \definecolor{tableShade
}{HTML
}{F8F8F8
}%
357 \rowcolors{1}{white
}{tableShade
}%
358 \arrayrulecolor{gray
}%
359 \setlength{\tabcolsep}{0.01\textwidth}%
360 \begin{longtable
}{|>
{\raggedleft\hspace{0pt
}}p
{0.25\textwidth}|
%
369 \newcommand{\doxyref}[3]{\textbf{#1} (
\textnormal{#2}\,
\pageref{#3})
}
370 \newenvironment{DoxyCompactList
}
372 \setlength{\leftmargin}{0.5cm
}
373 \setlength{\itemsep}{0pt
}
374 \setlength{\parsep}{0pt
}
375 \setlength{\topsep}{0pt
}
376 \renewcommand{\makelabel}{\hfill}}}
378 \newenvironment{DoxyCompactItemize
}
381 \setlength{\itemsep}{-
3pt
}
382 \setlength{\parsep}{0pt
}
383 \setlength{\topsep}{0pt
}
384 \setlength{\partopsep}{0pt
}
387 \newcommand{\PBS}[1]{\let\temp=\\
#1\let\\=
\temp}
388 \newlength{\tmplength}
389 \newenvironment{TabularC
}[1]
391 \setlength{\tmplength}
392 {\linewidth/(
#1)-
\tabcolsep*
2-
\arrayrulewidth*(
#1+
1)/(
#1)
}
393 \par\begin{tabular*
}{\linewidth}
394 {*
{#1}{|>
{\PBS\raggedright\hspace{0pt
}}p
{\the\tmplength}}|
}
397 \newcommand{\entrylabel}[1]{
398 {\parbox[b
]{\labelwidth-
4pt
}{\makebox[0pt
][l
]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
399 \newenvironment{Desc
}
402 \settowidth{\labelwidth}{40pt
}
403 \setlength{\leftmargin}{\labelwidth}
404 \setlength{\parsep}{0pt
}
405 \setlength{\itemsep}{-
4pt
}
406 \renewcommand{\makelabel}{\entrylabel}
410 \newenvironment{Indent
}
411 {\begin{list
}{}{\setlength{\leftmargin}{0.5cm
}}
412 \item[]\ignorespaces}
414 \setlength{\parindent}{0cm
}
415 \setlength{\parskip}{0.2cm
}
416 \addtocounter{secnumdepth
}{2}
417 \usepackage[T1]{fontenc}
419 \renewcommand{\paragraph}{\@startsection
{paragraph
}{4}{0ex
}%
422 {\usefont{OT1
}{phv
}{bc
}{n
}\color{darkgray
}}}
423 \renewcommand{\subparagraph}{\@startsection
{subparagraph
}{5}{0ex
}%
426 {\usefont{OT1
}{phv
}{bc
}{n
}\color{darkgray
}}}
428 \allsectionsfont{\usefont{OT1
}{phv
}{bc
}{n
}\selectfont\color{darkgray
}}
429 \stepcounter{secnumdepth
}
430 \stepcounter{tocdepth}
431 \definecolor{comment
}{rgb
}{0.5,
0.0,
0.0}
432 \definecolor{keyword
}{rgb
}{0.0,
0.5,
0.0}
433 \definecolor{keywordtype
}{rgb
}{0.38,
0.25,
0.125}
434 \definecolor{keywordflow
}{rgb
}{0.88,
0.5,
0.0}
435 \definecolor{preprocessor
}{rgb
}{0.5,
0.38,
0.125}
436 \definecolor{stringliteral
}{rgb
}{0.0,
0.125,
0.25}
437 \definecolor{charliteral
}{rgb
}{0.0,
0.5,
0.5}
438 \definecolor{vhdldigit
}{rgb
}{1.0,
0.0,
1.0}
439 \definecolor{vhdlkeyword
}{rgb
}{0.43,
0.0,
0.43}
440 \definecolor{vhdllogic
}{rgb
}{1.0,
0.0,
0.0}
441 \definecolor{vhdlchar
}{rgb
}{0.0,
0.0,
0.0}