← Back to branch summary

~josejuan-sanchez/esajpip/debian

« back to all changes in this revision

Viewing changes to doc/doxygen.sty

  • Committer: José Juan Sánchez Hernández
  • Date: 2013-04-02 18:14:26 UTC
  • Revision ID: josejuan.sanchez@gmail.com-20130402181426-07xn3djblburck53
Version for Debian

Show diffs side-by-side

added added

removed removed

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