Blame view

JChatClient/doc/latex/doxygen.sty 11.5 KB
1
2
3
4
5
6
7
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{doxygen}

% Packages used by this style file
\RequirePackage{alltt}
\RequirePackage{array}
\RequirePackage{calc}
8
9
10
\RequirePackage{color}
\RequirePackage{fancyhdr}
\RequirePackage{longtable}
11
\RequirePackage{verbatim}
12
\RequirePackage{ifthen}
13
\RequirePackage{xtab}
14
15
\RequirePackage{multirow}
\RequirePackage[table]{xcolor}
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
% Use helvetica font instead of times roman
\RequirePackage{helvet}
\RequirePackage{sectsty}
\RequirePackage{tocloft}
\providecommand{\rmdefault}{phv}
\providecommand{\bfdefault}{bc}


% Setup fancy headings
\pagestyle{fancyplain}
\newcommand{\clearemptydoublepage}{%
  \newpage{\pagestyle{empty}\cleardoublepage}%
}
\renewcommand{\chaptermark}[1]{%
  \markboth{#1}{}%
}
\renewcommand{\sectionmark}[1]{%
  \markright{\thesection\ #1}%
}
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
\fancyhead[CE]{\fancyplain{}{}}
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
\fancyhead[CO]{\fancyplain{}{}}
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
\fancyfoot[LE]{\fancyplain{}{}}
\fancyfoot[CE]{\fancyplain{}{}}
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generado el Martes, 10 de Diciembre de 2013 04\-:23\-:31 para Socket por Doxygen }}
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generado el Martes, 10 de Diciembre de 2013 04\-:23\-:31 para Socket por Doxygen }}
\fancyfoot[CO]{\fancyplain{}{}}
\fancyfoot[RO]{\fancyplain{}{}}
48
49
%---------- Internal commands used in this style file ----------------
50
51
52
53
54
55
56
\newcommand\tabfill[1]{%
  \dimen@\linewidth%
  \advance\dimen@\@totalleftmargin%
  \advance\dimen@-\dimen\@curtab%
  \parbox[t]\dimen@{\raggedright #1\ifhmode\strut\fi}%
}
57
\newcommand{\ensurespace}[1]{%
58
  \begingroup
59
    \setlength{\dimen@}{#1}%
60
61
62
    \vskip\z@\@plus\dimen@
    \penalty -100\vskip\z@\@plus -\dimen@
    \vskip\dimen@
63
    \penalty 9999%
64
65
66
    \vskip -\dimen@
    \vskip\z@skip % hide the previous |\vskip| from |\addvspace|
  \endgroup
67
68
}
69
70
71
% Generic environment used by all paragraph-based environments defined
% below. Note that the command \title{...} needs to be defined inside
% those environments!
72
73
\newenvironment{DoxyDesc}[1]{%
  \ensurespace{4\baselineskip}%
74
75
76
77
  \begin{list}{}%
  {%
    \settowidth{\labelwidth}{40pt}%
    \setlength{\leftmargin}{\labelwidth}%
78
    \setlength{\parsep}{0pt}%
79
    \setlength{\itemsep}{-4pt}%
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    \renewcommand{\makelabel}{\entrylabel}%
  }%
  \item[#1]%
}{%
  \end{list}%
}

%---------- Commands used by doxygen LaTeX output generator ----------

% Used by <pre> ... </pre>
\newenvironment{DoxyPre}{%
  \small%
  \begin{alltt}%
}{%
  \end{alltt}%
  \normalsize%
}

% Used by @code ... @endcode
\newenvironment{DoxyCode}{%
100
101
102


\begin{scriptsize}\begin{alltt}%
103
}{%
104
\end{alltt}\end{scriptsize}%
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
}

% Used by @example, @include, @includelineno and @dontinclude
\newenvironment{DoxyCodeInclude}{%
  \DoxyCode%
}{%
  \endDoxyCode%
}

% Used by @verbatim ... @endverbatim
\newenvironment{DoxyVerb}{%
  \footnotesize%
  \verbatim%
}{%
  \endverbatim%
  \normalsize%
}

% Used by @verbinclude
\newenvironment{DoxyVerbInclude}{%
  \DoxyVerb%
}{%
  \endDoxyVerb%
}

% Used by numbered lists (using '-#' or <ol> ... </ol>)
\newenvironment{DoxyEnumerate}{%
  \enumerate%
}{%
  \endenumerate%
}

% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
\newenvironment{DoxyItemize}{%
  \itemize%
}{%
  \enditemize%
}

% Used by description lists (using <dl> ... </dl>)
\newenvironment{DoxyDescription}{%
  \description%
}{%
  \enddescription%
}
151
% Used by @image, @dotfile, and @dot ... @enddot
152
153
154
% (only if caption is specified)
\newenvironment{DoxyImage}{%
  \begin{figure}[H]%
155
  \begin{center}%
156
}{%
157
  \end{center}%
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
  \end{figure}%
}

% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
% (only if no caption is specified)
\newenvironment{DoxyImageNoCaption}{%
}{%
}

% Used by @attention
\newenvironment{DoxyAttention}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @author and @authors
\newenvironment{DoxyAuthor}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @date
\newenvironment{DoxyDate}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @invariant
\newenvironment{DoxyInvariant}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @note
\newenvironment{DoxyNote}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @post
\newenvironment{DoxyPostcond}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @pre
\newenvironment{DoxyPrecond}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @copyright
\newenvironment{DoxyCopyright}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @remark
\newenvironment{DoxyRemark}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}
230
% Used by @return
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
\newenvironment{DoxyReturn}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @since
\newenvironment{DoxySince}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @see
\newenvironment{DoxySeeAlso}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @version
\newenvironment{DoxyVersion}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @warning
\newenvironment{DoxyWarning}[1]{%
  \begin{DoxyDesc}{#1}%
}{%
  \end{DoxyDesc}%
}

% Used by @internal
\newenvironment{DoxyInternal}[1]{%
  \paragraph*{#1}%
}{%
}

% Used by @par and @paragraph
\newenvironment{DoxyParagraph}[1]{%
273
274
  \begin{list}{}%
  {%
275
276
277
278
279
280
281
282
283
284
285
286
287
    \settowidth{\labelwidth}{40pt}%
    \setlength{\leftmargin}{\labelwidth}%
    \setlength{\parsep}{0pt}%
    \setlength{\itemsep}{-4pt}%
    \renewcommand{\makelabel}{\entrylabel}%
  }%
  \item[#1]%
}{%
  \end{list}%
}

% Used by parameter lists
\newenvironment{DoxyParams}[2][]{%
288
289
290
291
292
  \begin{DoxyDesc}{#2}%
    \item[] \hspace{\fill} \vspace{-40pt}%
    \settowidth{\labelwidth}{40pt}%
    \setlength{\LTleft}{0pt}%
    \setlength{\tabcolsep}{0.01\textwidth}%
293
    \ifthenelse{\equal{#1}{}}%
294
295
    {\begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
                        p{0.815\textwidth}|}}%
296
    {\ifthenelse{\equal{#1}{1}}%
297
      {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
298
                         >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
299
300
                         p{0.685\textwidth}|}}%
      {\begin{longtable}{|>{\centering}p{0.10\textwidth}|%
301
302
                         >{\centering\hspace{0pt}}p{0.15\textwidth}|%
                         >{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
303
                         p{0.515\textwidth}|}}%
304
305
    }\hline%
}{%
306
307
    \end{longtable}%
  \end{DoxyDesc}%
308
309
310
311
}

% Used for fields of simple structs
\newenvironment{DoxyFields}[1]{%
312
313
314
315
316
317
  \begin{DoxyDesc}{#1}%
    \item[] \hspace{\fill} \vspace{-40pt}%
    \settowidth{\labelwidth}{40pt}%
    \setlength{\LTleft}{0pt}%
    \setlength{\tabcolsep}{0.01\textwidth}%
    \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.15\textwidth}|%
318
                         p{0.15\textwidth}|%
319
                         p{0.635\textwidth}|}%
320
321
    \hline%
}{%
322
323
    \end{longtable}%
  \end{DoxyDesc}%
324
325
}
326
% is used for parameters within a detailed function description
327
328
\newenvironment{DoxyParamCaption}{%
  \renewcommand{\item}[2][]{##1 {\em ##2}}%
329
  }{%
330
331
332
333
}

% Used by return value lists
\newenvironment{DoxyRetVals}[1]{%
334
335
336
337
338
  \begin{DoxyDesc}{#1}%
    \begin{description}%
      \item[] \hspace{\fill} \vspace{-25pt}%
      \setlength{\tabcolsep}{0.01\textwidth}%
      \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
339
                          p{0.705\textwidth}|}%
340
      \hline%
341
}{%
342
343
344
      \end{longtable}%
    \end{description}%
  \end{DoxyDesc}%
345
346
347
348
}

% Used by exception lists
\newenvironment{DoxyExceptions}[1]{%
349
350
351
352
353
354
355
356
  \begin{DoxyDesc}{#1}%
    \begin{description}%
      \item[] \hspace{\fill} \vspace{-25pt}%
      \definecolor{tableShade}{HTML}{F8F8F8}%
      \rowcolors{1}{white}{tableShade}%
      \arrayrulecolor{gray}%
      \setlength{\tabcolsep}{0.01\textwidth}%
      \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
357
                          p{0.705\textwidth}|}%
358
      \hline%
359
}{%
360
361
362
      \end{longtable}%
    \end{description}%
  \end{DoxyDesc}%
363
364
365
366
}

% Used by template parameter lists
\newenvironment{DoxyTemplParams}[1]{%
367
368
369
370
371
372
373
374
  \begin{DoxyDesc}{#1}%
    \begin{description}%
      \item[] \hspace{\fill} \vspace{-25pt}%
      \definecolor{tableShade}{HTML}{F8F8F8}%
      \rowcolors{1}{white}{tableShade}%
      \arrayrulecolor{gray}%
      \setlength{\tabcolsep}{0.01\textwidth}%
      \begin{longtable}{|>{\raggedleft\hspace{0pt}}p{0.25\textwidth}|%
375
                          p{0.705\textwidth}|}%
376
      \hline%
377
}{%
378
379
380
      \end{longtable}%
    \end{description}%
  \end{DoxyDesc}%
381
}
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
\newenvironment{DoxyCompactList}
{\begin{list}{}{
  \setlength{\leftmargin}{0.5cm}
  \setlength{\itemsep}{0pt}
  \setlength{\parsep}{0pt}
  \setlength{\topsep}{0pt}
  \renewcommand{\makelabel}{\hfill}}}
{\end{list}}
\newenvironment{DoxyCompactItemize}
{
  \begin{itemize}
  \setlength{\itemsep}{-3pt}
  \setlength{\parsep}{0pt}
  \setlength{\topsep}{0pt}
  \setlength{\partopsep}{0pt}
}
{\end{itemize}}
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
\newlength{\tmplength}
\newenvironment{TabularC}[1]
{
\setlength{\tmplength}
     {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
      \par\begin{xtabular*}{\linewidth}
             {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
}
{\end{xtabular*}\par}
\newcommand{\entrylabel}[1]{
   {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{%
   \usefont{OT1}{phv}{bc}{n}\color{darkgray}#1}\vspace{1.5\baselineskip}}}}
\newenvironment{Desc}
{\begin{list}{}
  {
    \settowidth{\labelwidth}{40pt}
    \setlength{\leftmargin}{\labelwidth}
    \setlength{\parsep}{0pt}
    \setlength{\itemsep}{-4pt}
    \renewcommand{\makelabel}{\entrylabel}
  }
423
}
424
425
426
427
428
429
430
431
432
433
434
435
436
437
{\end{list}}
\newsavebox{\xrefbox}
\newlength{\xreflength}
\newcommand{\xreflabel}[1]{%
  \sbox{\xrefbox}{#1}%
  \setlength{\xreflength}{\wd\xrefbox}%
  \ifthenelse{\xreflength>\labelwidth}{%
    \begin{minipage}{\textwidth}%
      \setlength{\parindent}{0pt}%
      \hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
    \end{minipage}%
  }{%
   \parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
  }}%
438
439
440
441
442
443
\newenvironment{DoxyRefList}{%
  \begin{list}{}{%
    \setlength{\labelwidth}{10pt}%
    \setlength{\leftmargin}{\labelwidth}%
    \addtolength{\leftmargin}{\labelsep}%
    \renewcommand{\makelabel}{\xreflabel}%
444
    }%
445
  }%
446
447
{\end{list}}
\newenvironment{DoxyRefDesc}[1]
448
{\begin{list}{}{%
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
  \renewcommand\makelabel[1]{\textbf{##1}}
  \settowidth\labelwidth{\makelabel{#1}}
  \setlength\leftmargin{\labelwidth+\labelsep}}}
{\end{list}}
\newenvironment{Indent}
  {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
      \item[]\ignorespaces}
  {\unskip\end{list}}
\setlength{\parindent}{0cm}
\setlength{\parskip}{0.2cm}
\addtocounter{secnumdepth}{2}
\usepackage[T1]{fontenc}
\makeatletter
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}%
   {-1.0ex}%
   {1.0ex}%
   {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{0ex}%
   {-1.0ex}%
   {1.0ex}%
   {\usefont{OT1}{phv}{bc}{n}\color{darkgray}}}
\makeatother
\allsectionsfont{\usefont{OT1}{phv}{bc}{n}\selectfont\color{darkgray}}
\stepcounter{secnumdepth}
\stepcounter{tocdepth}
474
475
476
477
478
479
480
481
482
483
484
\definecolor{comment}{rgb}{0.5,0.0,0.0}
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}