1 | \NeedsTeXFormat{LaTeX2e} |
---|
2 | \ProvidesPackage{doxygen} |
---|
3 | |
---|
4 | % Packages used by this style file |
---|
5 | \RequirePackage{alltt} |
---|
6 | \RequirePackage{array} |
---|
7 | \RequirePackage{calc} |
---|
8 | \RequirePackage{float} |
---|
9 | \RequirePackage{ifthen} |
---|
10 | \RequirePackage{verbatim} |
---|
11 | \RequirePackage[table]{xcolor} |
---|
12 | \RequirePackage{xtab} |
---|
13 | |
---|
14 | %---------- Internal commands used in this style file ---------------- |
---|
15 | |
---|
16 | \newcommand{\ensurespace}[1]{% |
---|
17 | \begingroup% |
---|
18 | \setlength{\dimen@}{#1}% |
---|
19 | \vskip\z@\@plus\dimen@% |
---|
20 | \penalty -100\vskip\z@\@plus -\dimen@% |
---|
21 | \vskip\dimen@% |
---|
22 | \penalty 9999% |
---|
23 | \vskip -\dimen@% |
---|
24 | \vskip\z@skip% hide the previous |\vskip| from |\addvspace| |
---|
25 | \endgroup% |
---|
26 | } |
---|
27 | |
---|
28 | \newcommand{\DoxyLabelFont}{} |
---|
29 | \newcommand{\entrylabel}[1]{% |
---|
30 | {% |
---|
31 | \parbox[b]{\labelwidth-4pt}{% |
---|
32 | \makebox[0pt][l]{\DoxyLabelFont#1}% |
---|
33 | \vspace{1.5\baselineskip}% |
---|
34 | }% |
---|
35 | }% |
---|
36 | } |
---|
37 | |
---|
38 | \newenvironment{DoxyDesc}[1]{% |
---|
39 | \ensurespace{4\baselineskip}% |
---|
40 | \begin{list}{}{% |
---|
41 | \settowidth{\labelwidth}{20pt}% |
---|
42 | \setlength{\parsep}{0pt}% |
---|
43 | \setlength{\itemsep}{0pt}% |
---|
44 | \setlength{\leftmargin}{\labelwidth+\labelsep}% |
---|
45 | \renewcommand{\makelabel}{\entrylabel}% |
---|
46 | }% |
---|
47 | \item[#1]% |
---|
48 | }{% |
---|
49 | \end{list}% |
---|
50 | } |
---|
51 | |
---|
52 | \newsavebox{\xrefbox} |
---|
53 | \newlength{\xreflength} |
---|
54 | \newcommand{\xreflabel}[1]{% |
---|
55 | \sbox{\xrefbox}{#1}% |
---|
56 | \setlength{\xreflength}{\wd\xrefbox}% |
---|
57 | \ifthenelse{\xreflength>\labelwidth}{% |
---|
58 | \begin{minipage}{\textwidth}% |
---|
59 | \setlength{\parindent}{0pt}% |
---|
60 | \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}% |
---|
61 | \end{minipage}% |
---|
62 | }{% |
---|
63 | \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}% |
---|
64 | }% |
---|
65 | } |
---|
66 | |
---|
67 | %---------- Commands used by doxygen LaTeX output generator ---------- |
---|
68 | |
---|
69 | % Used by <pre> ... </pre> |
---|
70 | \newenvironment{DoxyPre}{% |
---|
71 | \small% |
---|
72 | \begin{alltt}% |
---|
73 | }{% |
---|
74 | \end{alltt}% |
---|
75 | \normalsize% |
---|
76 | } |
---|
77 | |
---|
78 | % Used by @code ... @endcode |
---|
79 | \newenvironment{DoxyCode}{% |
---|
80 | \par% |
---|
81 | \scriptsize% |
---|
82 | \begin{alltt}% |
---|
83 | }{% |
---|
84 | \end{alltt}% |
---|
85 | \normalsize% |
---|
86 | } |
---|
87 | |
---|
88 | % Used by @example, @include, @includelineno and @dontinclude |
---|
89 | \newenvironment{DoxyCodeInclude}{% |
---|
90 | \DoxyCode% |
---|
91 | }{% |
---|
92 | \endDoxyCode% |
---|
93 | } |
---|
94 | |
---|
95 | % Used by @verbatim ... @endverbatim |
---|
96 | \newenvironment{DoxyVerb}{% |
---|
97 | \footnotesize% |
---|
98 | \verbatim% |
---|
99 | }{% |
---|
100 | \endverbatim% |
---|
101 | \normalsize% |
---|
102 | } |
---|
103 | |
---|
104 | % Used by @verbinclude |
---|
105 | \newenvironment{DoxyVerbInclude}{% |
---|
106 | \DoxyVerb% |
---|
107 | }{% |
---|
108 | \endDoxyVerb% |
---|
109 | } |
---|
110 | |
---|
111 | % Used by numbered lists (using '-#' or <ol> ... </ol>) |
---|
112 | \newenvironment{DoxyEnumerate}{% |
---|
113 | \enumerate% |
---|
114 | }{% |
---|
115 | \endenumerate% |
---|
116 | } |
---|
117 | |
---|
118 | % Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>) |
---|
119 | \newenvironment{DoxyItemize}{% |
---|
120 | \itemize% |
---|
121 | }{% |
---|
122 | \enditemize% |
---|
123 | } |
---|
124 | |
---|
125 | % Used by description lists (using <dl> ... </dl>) |
---|
126 | \newenvironment{DoxyDescription}{% |
---|
127 | \description% |
---|
128 | }{% |
---|
129 | \enddescription% |
---|
130 | } |
---|
131 | |
---|
132 | % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc |
---|
133 | % (only if caption is specified) |
---|
134 | \newenvironment{DoxyImage}{% |
---|
135 | \begin{figure}[H]% |
---|
136 | \begin{center}% |
---|
137 | }{% |
---|
138 | \end{center}% |
---|
139 | \end{figure}% |
---|
140 | } |
---|
141 | |
---|
142 | % Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc |
---|
143 | % (only if no caption is specified) |
---|
144 | \newenvironment{DoxyImageNoCaption}{% |
---|
145 | \begin{center}% |
---|
146 | }{% |
---|
147 | \end{center}% |
---|
148 | } |
---|
149 | |
---|
150 | % Used by @attention |
---|
151 | \newenvironment{DoxyAttention}[1]{% |
---|
152 | \begin{DoxyDesc}{#1}% |
---|
153 | }{% |
---|
154 | \end{DoxyDesc}% |
---|
155 | } |
---|
156 | |
---|
157 | % Used by @author and @authors |
---|
158 | \newenvironment{DoxyAuthor}[1]{% |
---|
159 | \begin{DoxyDesc}{#1}% |
---|
160 | }{% |
---|
161 | \end{DoxyDesc}% |
---|
162 | } |
---|
163 | |
---|
164 | % Used by @date |
---|
165 | \newenvironment{DoxyDate}[1]{% |
---|
166 | \begin{DoxyDesc}{#1}% |
---|
167 | }{% |
---|
168 | \end{DoxyDesc}% |
---|
169 | } |
---|
170 | |
---|
171 | % Used by @invariant |
---|
172 | \newenvironment{DoxyInvariant}[1]{% |
---|
173 | \begin{DoxyDesc}{#1}% |
---|
174 | }{% |
---|
175 | \end{DoxyDesc}% |
---|
176 | } |
---|
177 | |
---|
178 | % Used by @note |
---|
179 | \newenvironment{DoxyNote}[1]{% |
---|
180 | \begin{DoxyDesc}{#1}% |
---|
181 | }{% |
---|
182 | \end{DoxyDesc}% |
---|
183 | } |
---|
184 | |
---|
185 | % Used by @post |
---|
186 | \newenvironment{DoxyPostcond}[1]{% |
---|
187 | \begin{DoxyDesc}{#1}% |
---|
188 | }{% |
---|
189 | \end{DoxyDesc}% |
---|
190 | } |
---|
191 | |
---|
192 | % Used by @pre |
---|
193 | \newenvironment{DoxyPrecond}[1]{% |
---|
194 | \begin{DoxyDesc}{#1}% |
---|
195 | }{% |
---|
196 | \end{DoxyDesc}% |
---|
197 | } |
---|
198 | |
---|
199 | % Used by @copyright |
---|
200 | \newenvironment{DoxyCopyright}[1]{% |
---|
201 | \begin{DoxyDesc}{#1}% |
---|
202 | }{% |
---|
203 | \end{DoxyDesc}% |
---|
204 | } |
---|
205 | |
---|
206 | % Used by @remark |
---|
207 | \newenvironment{DoxyRemark}[1]{% |
---|
208 | \begin{DoxyDesc}{#1}% |
---|
209 | }{% |
---|
210 | \end{DoxyDesc}% |
---|
211 | } |
---|
212 | |
---|
213 | % Used by @return and @returns |
---|
214 | \newenvironment{DoxyReturn}[1]{% |
---|
215 | \begin{DoxyDesc}{#1}% |
---|
216 | }{% |
---|
217 | \end{DoxyDesc}% |
---|
218 | } |
---|
219 | |
---|
220 | % Used by @since |
---|
221 | \newenvironment{DoxySince}[1]{% |
---|
222 | \begin{DoxyDesc}{#1}% |
---|
223 | }{% |
---|
224 | \end{DoxyDesc}% |
---|
225 | } |
---|
226 | |
---|
227 | % Used by @see |
---|
228 | \newenvironment{DoxySeeAlso}[1]{% |
---|
229 | \begin{DoxyDesc}{#1}% |
---|
230 | }{% |
---|
231 | \end{DoxyDesc}% |
---|
232 | } |
---|
233 | |
---|
234 | % Used by @version |
---|
235 | \newenvironment{DoxyVersion}[1]{% |
---|
236 | \begin{DoxyDesc}{#1}% |
---|
237 | }{% |
---|
238 | \end{DoxyDesc}% |
---|
239 | } |
---|
240 | |
---|
241 | % Used by @warning |
---|
242 | \newenvironment{DoxyWarning}[1]{% |
---|
243 | \begin{DoxyDesc}{#1}% |
---|
244 | }{% |
---|
245 | \end{DoxyDesc}% |
---|
246 | } |
---|
247 | |
---|
248 | % Used by @internal |
---|
249 | \newenvironment{DoxyInternal}[1]{% |
---|
250 | \paragraph*{#1}% |
---|
251 | }{% |
---|
252 | } |
---|
253 | |
---|
254 | % Used by @par and @paragraph |
---|
255 | \newenvironment{DoxyParagraph}[1]{% |
---|
256 | \begin{list}{}{% |
---|
257 | \settowidth{\labelwidth}{40pt}% |
---|
258 | \setlength{\leftmargin}{\labelwidth}% |
---|
259 | \setlength{\parsep}{0pt}% |
---|
260 | \setlength{\itemsep}{-4pt}% |
---|
261 | \renewcommand{\makelabel}{\entrylabel}% |
---|
262 | }% |
---|
263 | \item[#1]% |
---|
264 | }{% |
---|
265 | \end{list}% |
---|
266 | } |
---|
267 | |
---|
268 | % Used by parameter lists |
---|
269 | \newenvironment{DoxyParams}[2][]{% |
---|
270 | \par% |
---|
271 | \tabletail{\hline}% |
---|
272 | \tablelasttail{\hline}% |
---|
273 | \tablefirsthead{}% |
---|
274 | \tablehead{}% |
---|
275 | \ifthenelse{\equal{#1}{}}% |
---|
276 | {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}% |
---|
277 | \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
---|
278 | p{0.805\textwidth}|}}% |
---|
279 | {\ifthenelse{\equal{#1}{1}}% |
---|
280 | {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}% |
---|
281 | \begin{xtabular}{|>{\centering}p{0.10\textwidth}|% |
---|
282 | >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
---|
283 | p{0.678\textwidth}|}}% |
---|
284 | {\tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]}% |
---|
285 | \begin{xtabular}{|>{\centering}p{0.10\textwidth}|% |
---|
286 | >{\centering\hspace{0pt}}p{0.15\textwidth}|% |
---|
287 | >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
---|
288 | p{0.501\textwidth}|}}% |
---|
289 | }\hline% |
---|
290 | }{% |
---|
291 | \end{xtabular}% |
---|
292 | \tablefirsthead{}% |
---|
293 | \vspace{6pt}% |
---|
294 | } |
---|
295 | |
---|
296 | % Used for fields of simple structs |
---|
297 | \newenvironment{DoxyFields}[1]{% |
---|
298 | \par% |
---|
299 | \tabletail{\hline}% |
---|
300 | \tablelasttail{\hline}% |
---|
301 | \tablehead{}% |
---|
302 | \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}% |
---|
303 | \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
---|
304 | p{0.15\textwidth}|% |
---|
305 | p{0.63\textwidth}|}% |
---|
306 | \hline% |
---|
307 | }{% |
---|
308 | \end{xtabular}% |
---|
309 | \tablefirsthead{}% |
---|
310 | \vspace{6pt}% |
---|
311 | } |
---|
312 | |
---|
313 | % Used for parameters within a detailed function description |
---|
314 | \newenvironment{DoxyParamCaption}{% |
---|
315 | \renewcommand{\item}[2][]{##1 {\em ##2}}% |
---|
316 | }{% |
---|
317 | } |
---|
318 | |
---|
319 | % Used by return value lists |
---|
320 | \newenvironment{DoxyRetVals}[1]{% |
---|
321 | \par% |
---|
322 | \tabletail{\hline}% |
---|
323 | \tablelasttail{\hline}% |
---|
324 | \tablehead{}% |
---|
325 | \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}% |
---|
326 | \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
---|
327 | p{0.705\textwidth}|}% |
---|
328 | \hline% |
---|
329 | }{% |
---|
330 | \end{xtabular}% |
---|
331 | \tablefirsthead{}% |
---|
332 | \vspace{6pt}% |
---|
333 | } |
---|
334 | |
---|
335 | % Used by exception lists |
---|
336 | \newenvironment{DoxyExceptions}[1]{% |
---|
337 | \par% |
---|
338 | \tabletail{\hline}% |
---|
339 | \tablelasttail{\hline}% |
---|
340 | \tablehead{}% |
---|
341 | \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}% |
---|
342 | \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
---|
343 | p{0.705\textwidth}|}% |
---|
344 | \hline% |
---|
345 | }{% |
---|
346 | \end{xtabular}% |
---|
347 | \tablefirsthead{}% |
---|
348 | \vspace{6pt}% |
---|
349 | } |
---|
350 | |
---|
351 | % Used by template parameter lists |
---|
352 | \newenvironment{DoxyTemplParams}[1]{% |
---|
353 | \par% |
---|
354 | \tabletail{\hline}% |
---|
355 | \tablelasttail{\hline}% |
---|
356 | \tablehead{}% |
---|
357 | \tablefirsthead{\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]}% |
---|
358 | \begin{xtabular}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
---|
359 | p{0.705\textwidth}|}% |
---|
360 | \hline% |
---|
361 | }{% |
---|
362 | \end{xtabular}% |
---|
363 | \tablefirsthead{}% |
---|
364 | \vspace{6pt}% |
---|
365 | } |
---|
366 | |
---|
367 | % Used for member lists |
---|
368 | \newenvironment{DoxyCompactItemize}{% |
---|
369 | \begin{itemize}% |
---|
370 | \setlength{\itemsep}{-3pt}% |
---|
371 | \setlength{\parsep}{0pt}% |
---|
372 | \setlength{\topsep}{0pt}% |
---|
373 | \setlength{\partopsep}{0pt}% |
---|
374 | }{% |
---|
375 | \end{itemize}% |
---|
376 | } |
---|
377 | |
---|
378 | % Used for member descriptions |
---|
379 | \newenvironment{DoxyCompactList}{% |
---|
380 | \begin{list}{}{% |
---|
381 | \setlength{\leftmargin}{0.5cm}% |
---|
382 | \setlength{\itemsep}{0pt}% |
---|
383 | \setlength{\parsep}{0pt}% |
---|
384 | \setlength{\topsep}{0pt}% |
---|
385 | \renewcommand{\makelabel}{\hfill}% |
---|
386 | }% |
---|
387 | }{% |
---|
388 | \end{list}% |
---|
389 | } |
---|
390 | |
---|
391 | % Used for reference lists (@bug, @deprecated, @todo, etc.) |
---|
392 | \newenvironment{DoxyRefList}{% |
---|
393 | \begin{list}{}{% |
---|
394 | \setlength{\labelwidth}{10pt}% |
---|
395 | \setlength{\leftmargin}{\labelwidth}% |
---|
396 | \addtolength{\leftmargin}{\labelsep}% |
---|
397 | \renewcommand{\makelabel}{\xreflabel}% |
---|
398 | }% |
---|
399 | }{% |
---|
400 | \end{list}% |
---|
401 | } |
---|
402 | |
---|
403 | % Used by @bug, @deprecated, @todo, etc. |
---|
404 | \newenvironment{DoxyRefDesc}[1]{% |
---|
405 | \begin{list}{}{% |
---|
406 | \renewcommand\makelabel[1]{\textbf{##1}}% |
---|
407 | \settowidth\labelwidth{\makelabel{#1}}% |
---|
408 | \setlength\leftmargin{\labelwidth+\labelsep}% |
---|
409 | }% |
---|
410 | }{% |
---|
411 | \end{list}% |
---|
412 | } |
---|
413 | |
---|
414 | % Used by parameter lists and simple sections |
---|
415 | \newenvironment{Desc} |
---|
416 | {\begin{list}{}{% |
---|
417 | \settowidth{\labelwidth}{40pt}% |
---|
418 | \setlength{\leftmargin}{\labelwidth}% |
---|
419 | \setlength{\parsep}{0pt}% |
---|
420 | \setlength{\itemsep}{-4pt}% |
---|
421 | \renewcommand{\makelabel}{\entrylabel}% |
---|
422 | } |
---|
423 | }{% |
---|
424 | \end{list}% |
---|
425 | } |
---|
426 | |
---|
427 | % Used by tables |
---|
428 | \newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}% |
---|
429 | \newlength{\tmplength}% |
---|
430 | \newenvironment{TabularC}[1]% |
---|
431 | {% |
---|
432 | \setlength{\tmplength}% |
---|
433 | {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}% |
---|
434 | \par\begin{xtabular*}{\linewidth}% |
---|
435 | {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}% |
---|
436 | }% |
---|
437 | {\end{xtabular*}\par}% |
---|
438 | |
---|
439 | % Used by nested tables |
---|
440 | \newenvironment{TabularNC}[1]% |
---|
441 | {% |
---|
442 | \setlength{\tmplength}% |
---|
443 | {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}% |
---|
444 | \par\begin{tabular*}{\linewidth}% |
---|
445 | {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}% |
---|
446 | }% |
---|
447 | {\end{tabular*}\par}% |
---|
448 | |
---|
449 | % Used for member group headers |
---|
450 | \newenvironment{Indent}{% |
---|
451 | \begin{list}{}{% |
---|
452 | \setlength{\leftmargin}{0.5cm}% |
---|
453 | }% |
---|
454 | \item[]\ignorespaces% |
---|
455 | }{% |
---|
456 | \unskip% |
---|
457 | \end{list}% |
---|
458 | } |
---|
459 | |
---|
460 | % Used when hyperlinks are turned off |
---|
461 | \newcommand{\doxyref}[3]{% |
---|
462 | \textbf{#1} (\textnormal{#2}\,\pageref{#3})% |
---|
463 | } |
---|
464 | |
---|
465 | % Used by @addindex |
---|
466 | \newcommand{\lcurly}{\{} |
---|
467 | \newcommand{\rcurly}{\}} |
---|
468 | |
---|
469 | % Used for syntax highlighting |
---|
470 | \definecolor{comment}{rgb}{0.5,0.0,0.0} |
---|
471 | \definecolor{keyword}{rgb}{0.0,0.5,0.0} |
---|
472 | \definecolor{keywordtype}{rgb}{0.38,0.25,0.125} |
---|
473 | \definecolor{keywordflow}{rgb}{0.88,0.5,0.0} |
---|
474 | \definecolor{preprocessor}{rgb}{0.5,0.38,0.125} |
---|
475 | \definecolor{stringliteral}{rgb}{0.0,0.125,0.25} |
---|
476 | \definecolor{charliteral}{rgb}{0.0,0.5,0.5} |
---|
477 | \definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} |
---|
478 | \definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} |
---|
479 | \definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} |
---|
480 | \definecolor{vhdlchar}{rgb}{0.0,0.0,0.0} |
---|