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

Subversion Repositories funbase_ip_library

[/] [funbase_ip_library/] [trunk/] [TUT/] [ip.swp.driver/] [hibi_pe_dma/] [1.0/] [doc/] [sw_ref_doc_src/] [swdocstyle.sty] - Blame information for rev 145

Details | Compare with Previous | View Log

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