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{color} |
9 |
\RequirePackage{fancyhdr} |
10 |
\RequirePackage{longtable} |
11 |
\RequirePackage{verbatim} |
12 |
\RequirePackage{ifthen} |
13 |
\RequirePackage[table]{xcolor} |
14 |
|
15 |
% Use helvetica font instead of times roman |
16 |
\RequirePackage{helvet} |
17 |
\RequirePackage{sectsty} |
18 |
\RequirePackage{tocloft} |
19 |
\providecommand{\rmdefault}{phv} |
20 |
\providecommand{\bfdefault}{bc} |
21 |
|
22 |
|
23 |
% Setup fancy headings |
24 |
\pagestyle{fancyplain} |
25 |
\newcommand{\clearemptydoublepage}{% |
26 |
\newpage{\pagestyle{empty}\cleardoublepage}% |
27 |
} |
28 |
\renewcommand{\chaptermark}[1]{% |
29 |
\markboth{#1}{}% |
30 |
} |
31 |
\renewcommand{\sectionmark}[1]{% |
32 |
\markright{\thesection\ #1}% |
33 |
} |
34 |
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}} |
35 |
\fancyhead[CE]{\fancyplain{}{}} |
36 |
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}} |
37 |
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}} |
38 |
\fancyhead[CO]{\fancyplain{}{}} |
39 |
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} |
40 |
\fancyfoot[LE]{\fancyplain{}{}} |
41 |
\fancyfoot[CE]{\fancyplain{}{}} |
42 |
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Sun Apr 3 2016 08:26:24 for QuaZIP by Doxygen }} |
43 |
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Sun Apr 3 2016 08:26:24 for QuaZIP by Doxygen }} |
44 |
\fancyfoot[CO]{\fancyplain{}{}} |
45 |
\fancyfoot[RO]{\fancyplain{}{}} |
46 |
%---------- Internal commands used in this style file ---------------- |
47 |
|
48 |
% Generic environment used by all paragraph-based environments defined |
49 |
% below. Note that the command \title{...} needs to be defined inside |
50 |
% those environments! |
51 |
\newenvironment{DoxyDesc}[1]{% |
52 |
\begin{list}{}% |
53 |
{% |
54 |
\settowidth{\labelwidth}{40pt}% |
55 |
\setlength{\leftmargin}{\labelwidth}% |
56 |
\setlength{\parsep}{0pt}% |
57 |
\setlength{\itemsep}{-4pt}% |
58 |
\renewcommand{\makelabel}{\entrylabel}% |
59 |
}% |
60 |
\item[#1]% |
61 |
}{% |
62 |
\end{list}% |
63 |
} |
64 |
|
65 |
%---------- Commands used by doxygen LaTeX output generator ---------- |
66 |
|
67 |
% Used by <pre> ... </pre> |
68 |
\newenvironment{DoxyPre}{% |
69 |
\small% |
70 |
\begin{alltt}% |
71 |
}{% |
72 |
\end{alltt}% |
73 |
\normalsize% |
74 |
} |
75 |
|
76 |
% Used by @code ... @endcode |
77 |
\newenvironment{DoxyCode}{% |
78 |
\footnotesize% |
79 |
\verbatim% |
80 |
}{% |
81 |
\endverbatim% |
82 |
\normalsize% |
83 |
} |
84 |
|
85 |
% Used by @example, @include, @includelineno and @dontinclude |
86 |
\newenvironment{DoxyCodeInclude}{% |
87 |
\DoxyCode% |
88 |
}{% |
89 |
\endDoxyCode% |
90 |
} |
91 |
|
92 |
% Used by @verbatim ... @endverbatim |
93 |
\newenvironment{DoxyVerb}{% |
94 |
\footnotesize% |
95 |
\verbatim% |
96 |
}{% |
97 |
\endverbatim% |
98 |
\normalsize% |
99 |
} |
100 |
|
101 |
% Used by @verbinclude |
102 |
\newenvironment{DoxyVerbInclude}{% |
103 |
\DoxyVerb% |
104 |
}{% |
105 |
\endDoxyVerb% |
106 |
} |
107 |
|
108 |
% Used by numbered lists (using '-#' or <ol> ... </ol>) |
109 |
\newenvironment{DoxyEnumerate}{% |
110 |
\enumerate% |
111 |
}{% |
112 |
\endenumerate% |
113 |
} |
114 |
|
115 |
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>) |
116 |
\newenvironment{DoxyItemize}{% |
117 |
\itemize% |
118 |
}{% |
119 |
\enditemize% |
120 |
} |
121 |
|
122 |
% Used by description lists (using <dl> ... </dl>) |
123 |
\newenvironment{DoxyDescription}{% |
124 |
\description% |
125 |
}{% |
126 |
\enddescription% |
127 |
} |
128 |
|
129 |
% Used by @image, @dotfile, and @dot ... @enddot |
130 |
% (only if caption is specified) |
131 |
\newenvironment{DoxyImage}{% |
132 |
\begin{figure}[H]% |
133 |
\begin{center}% |
134 |
}{% |
135 |
\end{center}% |
136 |
\end{figure}% |
137 |
} |
138 |
|
139 |
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc |
140 |
% (only if no caption is specified) |
141 |
\newenvironment{DoxyImageNoCaption}{% |
142 |
}{% |
143 |
} |
144 |
|
145 |
% Used by @attention |
146 |
\newenvironment{DoxyAttention}[1]{% |
147 |
\begin{DoxyDesc}{#1}% |
148 |
}{% |
149 |
\end{DoxyDesc}% |
150 |
} |
151 |
|
152 |
% Used by @author and @authors |
153 |
\newenvironment{DoxyAuthor}[1]{% |
154 |
\begin{DoxyDesc}{#1}% |
155 |
}{% |
156 |
\end{DoxyDesc}% |
157 |
} |
158 |
|
159 |
% Used by @date |
160 |
\newenvironment{DoxyDate}[1]{% |
161 |
\begin{DoxyDesc}{#1}% |
162 |
}{% |
163 |
\end{DoxyDesc}% |
164 |
} |
165 |
|
166 |
% Used by @invariant |
167 |
\newenvironment{DoxyInvariant}[1]{% |
168 |
\begin{DoxyDesc}{#1}% |
169 |
}{% |
170 |
\end{DoxyDesc}% |
171 |
} |
172 |
|
173 |
% Used by @note |
174 |
\newenvironment{DoxyNote}[1]{% |
175 |
\begin{DoxyDesc}{#1}% |
176 |
}{% |
177 |
\end{DoxyDesc}% |
178 |
} |
179 |
|
180 |
% Used by @post |
181 |
\newenvironment{DoxyPostcond}[1]{% |
182 |
\begin{DoxyDesc}{#1}% |
183 |
}{% |
184 |
\end{DoxyDesc}% |
185 |
} |
186 |
|
187 |
% Used by @pre |
188 |
\newenvironment{DoxyPrecond}[1]{% |
189 |
\begin{DoxyDesc}{#1}% |
190 |
}{% |
191 |
\end{DoxyDesc}% |
192 |
} |
193 |
|
194 |
% Used by @remark |
195 |
\newenvironment{DoxyRemark}[1]{% |
196 |
\begin{DoxyDesc}{#1}% |
197 |
}{% |
198 |
\end{DoxyDesc}% |
199 |
} |
200 |
|
201 |
% Used by @return |
202 |
\newenvironment{DoxyReturn}[1]{% |
203 |
\begin{DoxyDesc}{#1}% |
204 |
}{% |
205 |
\end{DoxyDesc}% |
206 |
} |
207 |
|
208 |
% Used by @since |
209 |
\newenvironment{DoxySince}[1]{% |
210 |
\begin{DoxyDesc}{#1}% |
211 |
}{% |
212 |
\end{DoxyDesc}% |
213 |
} |
214 |
|
215 |
% Used by @see |
216 |
\newenvironment{DoxySeeAlso}[1]{% |
217 |
\begin{DoxyDesc}{#1}% |
218 |
}{% |
219 |
\end{DoxyDesc}% |
220 |
} |
221 |
|
222 |
% Used by @version |
223 |
\newenvironment{DoxyVersion}[1]{% |
224 |
\begin{DoxyDesc}{#1}% |
225 |
}{% |
226 |
\end{DoxyDesc}% |
227 |
} |
228 |
|
229 |
% Used by @warning |
230 |
\newenvironment{DoxyWarning}[1]{% |
231 |
\begin{DoxyDesc}{#1}% |
232 |
}{% |
233 |
\end{DoxyDesc}% |
234 |
} |
235 |
|
236 |
% Used by @internal |
237 |
\newenvironment{DoxyInternal}[1]{% |
238 |
\paragraph*{#1}% |
239 |
}{% |
240 |
} |
241 |
|
242 |
% Used by @par and @paragraph |
243 |
\newenvironment{DoxyParagraph}[1]{% |
244 |
\begin{list}{}% |
245 |
{% |
246 |
\settowidth{\labelwidth}{40pt}% |
247 |
\setlength{\leftmargin}{\labelwidth}% |
248 |
\setlength{\parsep}{0pt}% |
249 |
\setlength{\itemsep}{-4pt}% |
250 |
\renewcommand{\makelabel}{\entrylabel}% |
251 |
}% |
252 |
\item[#1]% |
253 |
}{% |
254 |
\end{list}% |
255 |
} |
256 |
|
257 |
% Used by parameter lists |
258 |
\newenvironment{DoxyParams}[2][]{% |
259 |
\begin{DoxyDesc}{#2}% |
260 |
\begin{description}% |
261 |
\item[] \hspace{\fill} \vspace{-25pt}% |
262 |
\definecolor{tableShade}{HTML}{F8F8F8}% |
263 |
\rowcolors{1}{white}{tableShade}% |
264 |
\arrayrulecolor{gray}% |
265 |
\setlength{\tabcolsep}{0.01\textwidth}% |
266 |
\ifthenelse{\equal{#1}{}} |
267 |
{\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
268 |
p{0.87\textwidth}|}}% |
269 |
{\ifthenelse{\equal{#1}{1}}% |
270 |
{\begin{longtable}{|>{\centering}p{0.10\textwidth}|% |
271 |
>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
272 |
p{0.75\textwidth}|}}% |
273 |
{\begin{longtable}{|>{\centering}p{0.10\textwidth}|% |
274 |
>{\centering\hspace{0pt}}p{0.15\textwidth}|% |
275 |
>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|% |
276 |
p{0.58\textwidth}|}}% |
277 |
}\hline% |
278 |
}{% |
279 |
\end{longtable}% |
280 |
\end{description}% |
281 |
\end{DoxyDesc}% |
282 |
} |
283 |
|
284 |
% is used for parameters within a detailed function description |
285 |
\newenvironment{DoxyParamCaption}{% |
286 |
\renewcommand{\item}[2][]{##1 {\em ##2}}% |
287 |
}{% |
288 |
} |
289 |
|
290 |
% Used by return value lists |
291 |
\newenvironment{DoxyRetVals}[1]{% |
292 |
\begin{DoxyDesc}{#1}% |
293 |
\begin{description}% |
294 |
\item[] \hspace{\fill} \vspace{-25pt}% |
295 |
\definecolor{tableShade}{HTML}{F8F8F8}% |
296 |
\rowcolors{1}{white}{tableShade}% |
297 |
\arrayrulecolor{gray}% |
298 |
\setlength{\tabcolsep}{0.01\textwidth}% |
299 |
\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
300 |
p{0.77\textwidth}|}% |
301 |
\hline% |
302 |
}{% |
303 |
\end{longtable}% |
304 |
\end{description}% |
305 |
\end{DoxyDesc}% |
306 |
} |
307 |
|
308 |
% Used by exception lists |
309 |
\newenvironment{DoxyExceptions}[1]{% |
310 |
\begin{DoxyDesc}{#1}% |
311 |
\begin{description}% |
312 |
\item[] \hspace{\fill} \vspace{-25pt}% |
313 |
\definecolor{tableShade}{HTML}{F8F8F8}% |
314 |
\rowcolors{1}{white}{tableShade}% |
315 |
\arrayrulecolor{gray}% |
316 |
\setlength{\tabcolsep}{0.01\textwidth}% |
317 |
\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
318 |
p{0.77\textwidth}|}% |
319 |
\hline% |
320 |
}{% |
321 |
\end{longtable}% |
322 |
\end{description}% |
323 |
\end{DoxyDesc}% |
324 |
} |
325 |
|
326 |
% Used by template parameter lists |
327 |
\newenvironment{DoxyTemplParams}[1]{% |
328 |
\begin{DoxyDesc}{#1}% |
329 |
\begin{description}% |
330 |
\item[] \hspace{\fill} \vspace{-25pt}% |
331 |
\definecolor{tableShade}{HTML}{F8F8F8}% |
332 |
\rowcolors{1}{white}{tableShade}% |
333 |
\arrayrulecolor{gray}% |
334 |
\setlength{\tabcolsep}{0.01\textwidth}% |
335 |
\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|% |
336 |
p{0.77\textwidth}|}% |
337 |
\hline% |
338 |
}{% |
339 |
\end{longtable}% |
340 |
\end{description}% |
341 |
\end{DoxyDesc}% |
342 |
} |
343 |
|
344 |
\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})} |
345 |
\newenvironment{DoxyCompactList} |
346 |
{\begin{list}{}{ |
347 |
\setlength{\leftmargin}{0.5cm} |
348 |
\setlength{\itemsep}{0pt} |
349 |
\setlength{\parsep}{0pt} |
350 |
\setlength{\topsep}{0pt} |
351 |
\renewcommand{\makelabel}{\hfill}}} |
352 |
{\end{list}} |
353 |
\newenvironment{DoxyCompactItemize} |
354 |
{ |
355 |
\begin{itemize} |
356 |
\setlength{\itemsep}{-3pt} |
357 |
\setlength{\parsep}{0pt} |
358 |
\setlength{\topsep}{0pt} |
359 |
\setlength{\partopsep}{0pt} |
360 |
} |
361 |
{\end{itemize}} |
362 |
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp} |
363 |
\newlength{\tmplength} |
364 |
\newenvironment{TabularC}[1] |
365 |
{ |
366 |
\setlength{\tmplength} |
367 |
{\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)} |
368 |
\par\begin{tabular*}{\linewidth} |
369 |
{*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|} |
370 |
} |
371 |
{\end{tabular*}\par} |
372 |
\newcommand{\entrylabel}[1]{ |
373 |
{\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}} |
374 |
\newenvironment{Desc} |
375 |
{\begin{list}{} |
376 |
{ |
377 |
\settowidth{\labelwidth}{40pt} |
378 |
\setlength{\leftmargin}{\labelwidth} |
379 |
\setlength{\parsep}{0pt} |
380 |
\setlength{\itemsep}{-4pt} |
381 |
\renewcommand{\makelabel}{\entrylabel} |
382 |
} |
383 |
} |
384 |
{\end{list}} |
385 |
\newenvironment{Indent} |
386 |
{\begin{list}{}{\setlength{\leftmargin}{0.5cm}} |
387 |
\item[]\ignorespaces} |
388 |
{\unskip\end{list}} |
389 |
\setlength{\parindent}{0cm} |
390 |
\setlength{\parskip}{0.2cm} |
391 |
\addtocounter{secnumdepth}{2} |
392 |
\usepackage[T1]{fontenc} |
393 |
\makeatletter |
394 |
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}% |
395 |
{-1.0ex}% |
396 |
{1.0ex}% |
397 |
{\usefont{OT1}{phv}{bc}{n}\color{darkgray}}} |
398 |
\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{0ex}% |
399 |
{-1.0ex}% |
400 |
{1.0ex}% |
401 |
{\usefont{OT1}{phv}{bc}{n}\color{darkgray}}} |
402 |
\makeatother |
403 |
\allsectionsfont{\usefont{OT1}{phv}{bc}{n}\selectfont\color{darkgray}} |
404 |
\stepcounter{secnumdepth} |
405 |
\stepcounter{tocdepth} |
406 |
\definecolor{comment}{rgb}{0.5,0.0,0.0} |
407 |
\definecolor{keyword}{rgb}{0.0,0.5,0.0} |
408 |
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125} |
409 |
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0} |
410 |
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125} |
411 |
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25} |
412 |
\definecolor{charliteral}{rgb}{0.0,0.5,0.5} |
413 |
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} |
414 |
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} |
415 |
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} |
416 |
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0} |