1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
151
152
153
154
155
156
157
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
230
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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
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
423
424
425
426
427
428
429
430
431
432
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<!-- This HTML file generated by cxref (version 1.6e). -->
<!-- cxref program (c) Andrew M. Bishop 1995-2014. -->
<!--
Cxref: ../src/cxref -O. -NREADME-TMP -xref -latex -html-src -rtf -sgml README.c
CPP : /home/amb/cxref/cpp/cxref-cpp -cxref-cpp-defines /home/amb/cxref/cpp/cxref-cpp.defines -lang-c -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Cross reference for README.c of README-TMP.</TITLE>
<LINK rel="stylesheet" href="cxref.css" type="text/css">
</HEAD>
<BODY>
<h1><a name="file" href="README.c.src.html">File README.c</a></h1>
<p>
<b>RCS Header: /home/amb/CVS/cxref/doc/README.c,v 1.4 1997-05-26 11:23:40 amb Exp </b>
<p>
<span class="cxref-file-comment">
A comment for the file, RCS header comments are treated specially when first.</span>
<hr>
<h2>Included Files</h2>
<p>
<span class="cxref-include-comment"> A #include comment </span>
<p>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include <stdio.h></span></tt>
</ul>
<p>
<span class="cxref-include-comment"> An alternative #include comment. </span>
<p>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include <math.h></span></tt>
</ul>
<hr>
<h2>Preprocessor definitions</h2>
<p>
<span class="cxref-define-comment"> A #define comment. </span>
<p>
<tt><span class="cxref-define"><a href="README.c.src.html#line17">#define def1</a> 1</span></tt>
<p>
<span class="cxref-define-comment"> An alternative #define comment. </span>
<p>
<tt><span class="cxref-define"><a href="README.c.src.html#line20">#define def2</a> 2</span></tt>
<p>
<span class="cxref-define-comment"> A #define with args</span>
<p>
<tt><span class="cxref-define"><a href="README.c.src.html#line31">#define def3</a>( arg1, arg2 )</span></tt>
<br>
<dl>
<dt><tt><span class="cxref-define">arg1</span></tt>
<dd><span class="cxref-define-comment">The first arg</span>
<dt><tt><span class="cxref-define">arg2</span></tt>
<dd><span class="cxref-define-comment">The second arg</span>
</dl>
<p>
<span class="cxref-define-comment"> An alternative #define with args. </span>
<p>
<tt><span class="cxref-define"><a href="README.c.src.html#line36">#define def4</a>( arg1, arg2 )</span></tt>
<br>
<dl>
<dt><tt><span class="cxref-define">arg1</span></tt>
<dd><span class="cxref-define-comment"> The first arg </span>
<dt><tt><span class="cxref-define">arg2</span></tt>
<dd><span class="cxref-define-comment"> The second arg </span>
</dl>
<hr>
<h2><a name="type-type1">Typedef type1</a></h2>
<p>
<span class="cxref-type-comment"> An example typedef comment </span>
<p>
<tt><span class="cxref-type"><a href="README.c.src.html#line43">typedef enum {...} type1</a></span></tt>
<br>
<table>
<tr>
<td><tt><span class="cxref-type">enum</span></tt>
<td>
</tr>
<tr>
<td> <tt><span class="cxref-type">{</span></tt>
<td>
</tr>
<tr>
<td>
<tt><span class="cxref-type">one;</span></tt>
<td><span class="cxref-type-comment"> one value </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">two;</span></tt>
<td><span class="cxref-type-comment"> another value </span>
</tr>
<tr>
<td> <tt><span class="cxref-type">}</span></tt>
<td>
</tr>
</table>
<hr>
<h2><a name="type-union-bar">Type union bar</a></h2>
<p>
<span class="cxref-type-comment"> Nested structs and unions also work. </span>
<br>
<tt><span class="cxref-type"><a href="README.c.src.html#line61">union bar</a></span></tt>
<br>
<table>
<tr>
<td><tt><span class="cxref-type">union bar</span></tt>
<td>
</tr>
<tr>
<td> <tt><span class="cxref-type">{</span></tt>
<td>
</tr>
<tr>
<td>
<tt><span class="cxref-type">char a;</span></tt>
<td><span class="cxref-type-comment"> Each element </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">int b;</span></tt>
<td><span class="cxref-type-comment"> of a struct </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">int c;</span></tt>
<td><span class="cxref-type-comment"> or a union </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">long d;</span></tt>
<td><span class="cxref-type-comment"> can have a comment </span>
</tr>
<tr>
<td> <tt><span class="cxref-type">}</span></tt>
<td>
</tr>
</table>
<hr>
<h2><a name="type-type2">Typedef type2</a></h2>
<p>
<span class="cxref-type-comment"> Another example typedef comment, a type that is a struct. </span>
<p>
<tt><span class="cxref-type"><a href="README.c.src.html#line52">typedef struct {...} type2</a></span></tt>
<br>
<table>
<tr>
<td><tt><span class="cxref-type">struct</span></tt>
<td>
</tr>
<tr>
<td> <tt><span class="cxref-type">{</span></tt>
<td>
</tr>
<tr>
<td>
<tt><span class="cxref-type">int a;</span></tt>
<td><span class="cxref-type-comment"> A variable in a struct. </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">union bar</span></tt>
<td>
</tr>
<tr>
<td> <tt><span class="cxref-type">{</span></tt>
<td>
</tr>
<tr>
<td>
<tt><span class="cxref-type">char a;</span></tt>
<td><span class="cxref-type-comment"> Each element </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">int b;</span></tt>
<td><span class="cxref-type-comment"> of a struct </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">int c;</span></tt>
<td><span class="cxref-type-comment"> or a union </span>
</tr>
<tr>
<td>
<tt><span class="cxref-type">long d;</span></tt>
<td><span class="cxref-type-comment"> can have a comment </span>
</tr>
<tr>
<td> <tt><span class="cxref-type">}</span></tt>
<td>
</tr>
<tr>
<td> <tt><span class="cxref-type">e;</span></tt>
<td><span class="cxref-type-comment"> Nested structs and unions also work. </span>
</tr>
<tr>
<td> <tt><span class="cxref-type">}</span></tt>
<td>
</tr>
</table>
<hr>
<h2><a name="type-ptype2">Typedef ptype2</a></h2>
<p>
<span class="cxref-type-comment"> Another example typedef comment, a pointer to a struct type. </span>
<p>
<tt><span class="cxref-type"><a href="README.c.src.html#line52">typedef struct {...}* ptype2</a></span></tt>
<br>
<table>
<tr>
<td>See:
<td><span class="cxref-reference-local"><a href="#type-type2">Typedef type2</a></span>
</tr>
</table>
<hr>
<h2><a name="var-var1">Global Variable var1</a></h2>
<p>
<span class="cxref-variable-comment"> A leading comment only. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line68">int var1</a></span></tt>
<br>
<table>
<tr>
<td>Visible in:
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#file">README.c</a></span>
</tr>
<tr>
<td>Used in:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">function1()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">README.c</a></span>
</tr>
</table>
<hr>
<h2><a name="var-var2">Global Variable var2</a></h2>
<p>
<span class="cxref-variable-comment"> A leading comment only. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line68">int var2</a></span></tt>
<br>
<table>
<tr>
<td>Visible in:
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#file">README.c</a></span>
</tr>
</table>
<hr>
<h2><a name="var-var4">Global Variable var4</a></h2>
<p>
<span class="cxref-variable-comment"> A variable for one thing. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line75">int var4</a></span></tt>
<br>
<table>
<tr>
<td>Visible in:
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#file">README.c</a></span>
</tr>
<tr>
<td>Used in:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">function1()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">README.c</a></span>
</tr>
</table>
<hr>
<h2><a name="var-var5">Global Variable var5</a></h2>
<p>
<span class="cxref-variable-comment"> A variable for a second thing. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line76">int var5</a></span></tt>
<br>
<table>
<tr>
<td>Visible in:
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#file">README.c</a></span>
</tr>
</table>
<hr>
<h2><a name="var-var6">Global Variable var6</a></h2>
<p>
<span class="cxref-variable-comment"> A variable for a third thing. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line77">int var6</a></span></tt>
<br>
<table>
<tr>
<td>Visible in:
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#file">README.c</a></span>
</tr>
</table>
<hr>
<h2>Local Variables</h2>
<p>
<b><a name="var-var3">var3</a></b><br>
<p>
<span class="cxref-variable-comment"> A trailing comment only. </span>
<p>
<tt><span class="cxref-variable"><a href="README.c.src.html#line71">static int var3</a></span></tt>
<br>
<table>
<tr>
<td>Used in:
<td><a href="#func-function1">function1()</a>
<td>
</tr>
</table>
<hr>
<h2><a name="func-function1">Global Function function1()</a></h2>
<p>
<span class="cxref-function-comment"> A function comment (the comments for the args need to be separated by a blank line).</span>
<p>
<tt><span class="cxref-function"><a href="README.c.src.html#line99">int function1 ( int arg1, int arg2 )</a></span></tt>
<br>
<dl>
<dt><tt><span class="cxref-function">int function1</span></tt>
<dd><span class="cxref-function-comment">The return value.</span>
<dt><tt><span class="cxref-function">int arg1</span></tt>
<dd><span class="cxref-function-comment">The first argument.</span>
<dt><tt><span class="cxref-function">int arg2</span></tt>
<dd><span class="cxref-function-comment">The second argument.</span>
</dl>
<p>
<span class="cxref-function-comment"> Some more comments
<br>
This comment is only visible in the HTML output, and can contain HTML markup.
<br>
An internal comment in a function that appears as a
new paragraph at the end of the comment. </span>
<p>
<table>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function2">function2()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function2">README.c</a></span>
</tr>
<tr>
<td>Used in:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function2">function2()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function2">README.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="README.c.html#var-var1">var1</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#var-var1">README.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#var-var3">var3</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#var-var3">README.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="README.c.html#var-var4">var4</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#var-var4">README.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-function2">Global Function function2()</a></h2>
<p>
<span class="cxref-function-comment"> An alternative function comment </span>
<p>
<tt><span class="cxref-function"><a href="README.c.src.html#line112">int function2 ( int arg1, int arg2, void )</a></span></tt>
<br>
<dl>
<dt><tt><span class="cxref-function">int function2</span></tt>
<dd><span class="cxref-function-comment"> Returns a value </span>
<dt><tt><span class="cxref-function">int arg1</span></tt>
<dd><span class="cxref-function-comment"> The first argument. </span>
<dt><tt><span class="cxref-function">int arg2</span></tt>
<dd><span class="cxref-function-comment"> The second argument. </span>
<dt><tt><span class="cxref-function">void</span></tt>
<dd><span class="cxref-function-comment"> </span>
</dl>
<p>
<table>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">function1()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">README.c</a></span>
</tr>
<tr>
<td>References Functions:
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">function1()</a></span>
<td><span class="cxref-reference-local"><a href="README.c.html#func-function1">README.c</a></span>
</tr>
</table>
</BODY>
</HTML>
|
