OpenCores
URL https://opencores.org/ocsvn/uart_block/uart_block/trunk

Subversion Repositories uart_block

[/] [uart_block/] [trunk/] [docs/] [doxygenDocs/] [latex/] [doxygen.sty] - Blame information for rev 40

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.