Chameleon

Chameleon Svn Source Tree

Root/branches/xZenu/src/util/doxygen/doc/doxygen.sty

Source at commit 1322 created 9 years 5 months ago.
By meklort, Add doxygen to utils folder
1%
2%
3%
4% Copyright (C) 1997-2011 by Dimitri van Heesch.
5%
6% Permission to use, copy, modify, and distribute this software and its
7% documentation under the terms of the GNU General Public License is hereby
8% granted. No representations are made about the suitability of this software
9% for any purpose. It is provided "as is" without express or implied warranty.
10% See the GNU General Public License for more details.
11%
12% Documents produced by Doxygen are derivative works derived from the
13% input used in their production; they are not affected by this license.
14
15\NeedsTeXFormat{LaTeX2e}
16\ProvidesPackage{doxygen}
17\RequirePackage{calc}
18\RequirePackage{array}
19\RequirePackage{verbatim}
20\pagestyle{fancyplain}
21\addtolength{\headwidth}{\marginparsep}
22\addtolength{\headwidth}{\marginparwidth}
23\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
24\lhead[\fancyplain{}{\bfseries\thepage}]
25 {\fancyplain{}{\bfseries\rightmark}}
26\rhead[\fancyplain{}{\bfseries\leftmark}]
27 {\fancyplain{}{\bfseries\thepage}}
28\rfoot[\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2011}]{}
29\lfoot[]{\fancyplain{}{\bfseries\scriptsize User Manual for Doxygen $VERSION, written by Dimitri van Heesch \copyright 1997-2011}}
30\cfoot{}
31
32%---------- Internal commands used in this style file ----------------
33
34% Generic environment used by all paragraph-based environments defined
35% below. Note that the command \title{...} needs to be defined inside
36% those environments!
37\newenvironment{DoxyDesc}[1]{%
38 \begin{list}{}%
39 {%
40 \settowidth{\labelwidth}{40pt}%
41 \setlength{\leftmargin}{\labelwidth}%
42 \setlength{\parsep}{0pt}%
43 \setlength{\itemsep}{-4pt}%
44 \renewcommand{\makelabel}{\entrylabel}%
45 }%
46 \item[#1:]%
47}{%
48 \end{list}%
49}
50
51%---------- Commands used by doxygen LaTeX output generator ----------
52
53% Used by <pre> ... </pre>
54\newenvironment{DoxyPre}{%
55 \small%
56 \begin{alltt}%
57}{%
58 \end{alltt}%
59 \normalsize%
60}
61
62% Used by @code ... @endcode
63\newenvironment{DoxyCode}{%
64 \footnotesize%
65 \verbatim%
66}{%
67 \endverbatim%
68 \normalsize%
69}
70
71% Used by @example, @include, @includelineno and @dontinclude
72\newenvironment{DoxyCodeInclude}{%
73 \DoxyCode%
74}{%
75 \endDoxyCode%
76}
77
78% Used by @verbatim ... @endverbatim
79\newenvironment{DoxyVerb}{%
80 \footnotesize%
81 \verbatim%
82}{%
83 \endverbatim%
84 \normalsize%
85}
86
87% Used by @verbinclude
88\newenvironment{DoxyVerbInclude}{%
89 \DoxyVerb%
90}{%
91 \endDoxyVerb%
92}
93
94% Used by numbered lists (using '-#' or <ol> ... </ol>)
95\newenvironment{DoxyEnumerate}{%
96 \enumerate%
97}{%
98 \endenumerate%
99}
100
101% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
102\newenvironment{DoxyItemize}{%
103 \itemize%
104}{%
105 \enditemize%
106}
107
108% Used by description lists (using <dl> ... </dl>)
109\newenvironment{DoxyDescription}{%
110 \description%
111}{%
112 \enddescription%
113}
114
115% Used by @image, @dotfile, and @dot ... @enddot
116% (only if caption is specified)
117\newenvironment{DoxyImage}{%
118 \begin{figure}[H]%
119 \begin{center}%
120}{%
121 \end{center}%
122 \end{figure}%
123}
124
125% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
126% (only if no caption is specified)
127\newenvironment{DoxyImageNoCaption}{%
128}{%
129}
130
131% Used by @attention
132\newenvironment{DoxyAttention}[1]{%
133 \begin{DoxyDesc}{#1}%
134}{%
135 \end{DoxyDesc}%
136}
137
138% Used by @author and @authors
139\newenvironment{DoxyAuthor}[1]{%
140 \begin{DoxyDesc}{#1}%
141}{%
142 \end{DoxyDesc}%
143}
144
145% Used by @date
146\newenvironment{DoxyDate}[1]{%
147 \begin{DoxyDesc}{#1}%
148}{%
149 \end{DoxyDesc}%
150}
151
152% Used by @invariant
153\newenvironment{DoxyInvariant}[1]{%
154 \begin{DoxyDesc}{#1}%
155}{%
156 \end{DoxyDesc}%
157}
158
159% Used by @note
160\newenvironment{DoxyNote}[1]{%
161 \begin{DoxyDesc}{#1}%
162}{%
163 \end{DoxyDesc}%
164}
165
166% Used by @post
167\newenvironment{DoxyPostcond}[1]{%
168 \begin{DoxyDesc}{#1}%
169}{%
170 \end{DoxyDesc}%
171}
172
173% Used by @pre
174\newenvironment{DoxyPrecond}[1]{%
175 \begin{DoxyDesc}{#1}%
176}{%
177 \end{DoxyDesc}%
178}
179
180% Used by @remark
181\newenvironment{DoxyRemark}[1]{%
182 \begin{DoxyDesc}{#1}%
183}{%
184 \end{DoxyDesc}%
185}
186
187% Used by @return
188\newenvironment{DoxyReturn}[1]{%
189 \begin{DoxyDesc}{#1}%
190}{%
191 \end{DoxyDesc}%
192}
193
194% Used by @since
195\newenvironment{DoxySince}[1]{%
196 \begin{DoxyDesc}{#1}%
197}{%
198 \end{DoxyDesc}%
199}
200
201% Used by @see
202\newenvironment{DoxySeeAlso}[1]{%
203 \begin{DoxyDesc}{#1}%
204}{%
205 \end{DoxyDesc}%
206}
207
208% Used by @version
209\newenvironment{DoxyVersion}[1]{%
210 \begin{DoxyDesc}{#1}%
211}{%
212 \end{DoxyDesc}%
213}
214
215% Used by @warning
216\newenvironment{DoxyWarning}[1]{%
217 \begin{DoxyDesc}{#1}%
218}{%
219 \end{DoxyDesc}%
220}
221
222% Used by @internal
223\newenvironment{DoxyInternal}[1]{%
224 \begin{DoxyDesc}{#1}%
225}{%
226 \end{DoxyDesc}%
227}
228
229% Used by @par and @paragraph
230\newenvironment{DoxyParagraph}[1]{%
231 \begin{list}{}%
232 {%
233 \settowidth{\labelwidth}{40pt}%
234 \setlength{\leftmargin}{\labelwidth}%
235 \setlength{\parsep}{0pt}%
236 \setlength{\itemsep}{-4pt}%
237 \renewcommand{\makelabel}{\entrylabel}%
238 }%
239 \item[#1]%
240}{%
241 \end{list}%
242}
243
244% Used by parameter lists
245\newenvironment{DoxyParams}[1]{%
246 \begin{DoxyDesc}{#1}%
247 \begin{description}%
248}{%
249 \end{description}%
250 \end{DoxyDesc}%
251}
252
253% Used by return value lists
254\newenvironment{DoxyRetVals}[1]{%
255 \begin{DoxyDesc}{#1}%
256 \begin{description}%
257}{%
258 \end{description}%
259 \end{DoxyDesc}%
260}
261
262% Used by exception lists
263\newenvironment{DoxyExceptions}[1]{%
264 \begin{DoxyDesc}{#1}%
265 \begin{description}%
266}{%
267 \end{description}%
268 \end{DoxyDesc}%
269}
270
271% Used by template parameter lists
272\newenvironment{DoxyTemplParams}[1]{%
273 \begin{DoxyDesc}{#1}%
274 \begin{description}%
275}{%
276 \end{description}%
277 \end{DoxyDesc}%
278}
279
280\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})}
281\newenvironment{DoxyCompactList}
282{\begin{list}{}{
283 \setlength{\leftmargin}{0.5cm}
284 \setlength{\itemsep}{0pt}
285 \setlength{\parsep}{0pt}
286 \setlength{\topsep}{0pt}
287 \renewcommand{\makelabel}{}}}
288{\end{list}}
289\newenvironment{DoxyCompactItemize}
290{
291 \begin{itemize}
292 \setlength{\itemsep}{-4pt}
293 \setlength{\parsep}{0pt}
294 \setlength{\topsep}{0pt}
295 \setlength{\partopsep}{0pt}
296}
297{\end{itemize}}
298\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
299\newlength{\tmplength}
300\newenvironment{TabularC}[1]
301{
302\setlength{\tmplength}
303 {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
304 \par\begin{tabular*}{\linewidth}
305 {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
306}
307{\end{tabular*}\par}
308\newcommand{\entrylabel}[1]{
309 {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}}
310\newenvironment{Desc}
311{\begin{list}{}
312 {
313 \settowidth{\labelwidth}{40pt}
314 \setlength{\leftmargin}{\labelwidth}
315 \setlength{\parsep}{0pt}
316 \setlength{\itemsep}{-4pt}
317 \renewcommand{\makelabel}{\entrylabel}
318 }
319}
320{\end{list}}
321\setlength{\parindent}{0cm}
322\setlength{\parskip}{0.2cm}
323\sloppy
324

Archive Download this file

Revision: 1322