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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!-- This HTML file generated by cxref. -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98,99. -->
<!--
Cxref: /home/amb/cxref/cxref -O/home/amb/cxref/doc -NREADME -xref -latex2e -html32-src -rtf -sgml README.c
CPP : gcc -E -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Cross reference for README.c of README.</TITLE>
</HEAD>
<BODY>
<h1><a name="file" href="README.c.src.html">File README.c</a></h1>
<b>RCS Header: /home/amb/cxref/RCS/README.c 1.4 1997/05/26 11:23:40 amb Exp </b>
<p>
A comment for the file, RCS header comments are treated specially when first.
<p>
<hr>
<h2>Included Files</h2>
A #include comment
<p>
<ul>
<li><tt>#include <stdio.h></tt>
</ul>
An alternative #include comment.
<p>
<ul>
<li><tt>#include <math.h></tt>
</ul>
<hr>
<h2>Preprocessor definitions</h2>
A #define comment.
<p>
<tt><a href="README.c.src.html#line17">#define def1</a> 1</tt><br>
<p>
An alternative #define comment.
<p>
<tt><a href="README.c.src.html#line20">#define def2</a> 2</tt><br>
<p>
A #define with args
<p>
<tt><a href="README.c.src.html#line31">#define def3</a>( arg1, arg2 )</tt><br>
<dl compact>
<dt><tt>arg1</tt>
<dd>The first arg
<dt><tt>arg2</tt>
<dd>The second arg
</dl>
<p>
An alternative #define with args.
<p>
<tt><a href="README.c.src.html#line36">#define def4</a>( arg1, arg2 )</tt><br>
<dl compact>
<dt><tt>arg1</tt>
<dd> The first arg
<dt><tt>arg2</tt>
<dd> The second arg
</dl>
<hr>
<h2><a name="type-type1">Typedef type1</a></h2>
An example typedef comment
<p>
<tt><a href="README.c.src.html#line43">typedef enum {...} type1</a></tt><br>
<table>
<tr><td><tt>enum</tt><td>
<tr><td> <tt>{</tt><td>
<tr><td> <tt>one;</tt><td> one value
<tr><td> <tt>two;</tt><td> another value
<tr><td> <tt>}</tt><td>
</table>
<hr>
<h2><a name="type-union-bar">Type union bar</a></h2>
Nested structs and unions also work.
<p>
<tt><a href="README.c.src.html#line0">union bar</a></tt><br>
<table>
<tr><td><tt>union bar</tt><td>
<tr><td> <tt>{</tt><td>
<tr><td> <tt>char a;</tt><td> Each element
<tr><td> <tt>int b;</tt><td> of a struct
<tr><td> <tt>int c;</tt><td> or a union
<tr><td> <tt>long d;</tt><td> can have a comment
<tr><td> <tt>}</tt><td>
</table>
<hr>
<h2><a name="type-type2">Typedef type2</a></h2>
Another example typedef comment, a type that is a struct.
<p>
<tt><a href="README.c.src.html#line52">typedef struct {...} type2</a></tt><br>
<table>
<tr><td><tt>struct</tt><td>
<tr><td> <tt>{</tt><td>
<tr><td> <tt>int a;</tt><td> A variable in a struct.
<tr><td> <tt>union bar</tt><td>
<tr><td> <tt>{</tt><td>
<tr><td> <tt>char a;</tt><td> Each element
<tr><td> <tt>int b;</tt><td> of a struct
<tr><td> <tt>int c;</tt><td> or a union
<tr><td> <tt>long d;</tt><td> can have a comment
<tr><td> <tt>}</tt><td>
<tr><td> <tt>e;</tt><td> Nested structs and unions also work.
<tr><td> <tt>}</tt><td>
</table>
<hr>
<h2><a name="type-ptype2">Typedef ptype2</a></h2>
Another example typedef comment, a pointer to a struct type.
<p>
<tt><a href="README.c.src.html#line52">typedef struct {...}* ptype2</a></tt><br>
<dl compact>
<dt>See:
<dd><ul>
<li><a href="#type-type2">Typedef type2</a>
</ul>
</dl>
<hr>
<h2><a name="var-var1">Global Variable var1</a></h2>
A leading comment only.
<p>
<tt><a href="README.c.src.html#line68">int var1</a></tt><br>
<table>
<tr><td>Visible in:
<td> <td><a href="README.c.html#file">README.c</a>
<tr><td>Used in:
<td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
</table>
<hr>
<h2><a name="var-var2">Global Variable var2</a></h2>
A leading comment only.
<p>
<tt><a href="README.c.src.html#line68">int var2</a></tt><br>
<table>
<tr><td>Visible in:
<td> <td><a href="README.c.html#file">README.c</a>
</table>
<hr>
<h2><a name="var-var4">Global Variable var4</a></h2>
A variable for one thing.
<p>
<tt><a href="README.c.src.html#line75">int var4</a></tt><br>
<table>
<tr><td>Visible in:
<td> <td><a href="README.c.html#file">README.c</a>
<tr><td>Used in:
<td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
</table>
<hr>
<h2><a name="var-var5">Global Variable var5</a></h2>
A variable for a second thing.
<p>
<tt><a href="README.c.src.html#line76">int var5</a></tt><br>
<table>
<tr><td>Visible in:
<td> <td><a href="README.c.html#file">README.c</a>
</table>
<hr>
<h2><a name="var-var6">Global Variable var6</a></h2>
A variable for a third thing.
<p>
<tt><a href="README.c.src.html#line77">int var6</a></tt><br>
<table>
<tr><td>Visible in:
<td> <td><a href="README.c.html#file">README.c</a>
</table>
<hr>
<h2>Local Variables</h2>
<b><a name="var-var3">var3</a></b><br>
A trailing comment only.
<p>
<tt><a href="README.c.src.html#line71">static int var3</a></tt><br>
<table>
<tr><td>Used in:
<td><a href="#func-function1">function1()</a>
</table>
<hr>
<h2><a name="func-function1">Global Function function1()</a></h2>
A function comment (the comments for the args need to be separated by a blank line).
<p>
<tt><a href="README.c.src.html#line99">int function1 ( int arg1, int arg2 )</a></tt><br>
<dl compact>
<dt><tt>int function1</tt>
<dd>The return value.
<dt><tt>int arg1</tt>
<dd>The first argument.
<dt><tt>int arg2</tt>
<dd>The second argument.
</dl>
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.
<p>
<table>
<tr><td>Calls:
<td><a href="README.c.html#func-function2">function2()</a><td><a href="README.c.html#func-function2">README.c</a>
<tr><td>Used in:
<td><a href="README.c.html#func-function2">function2()</a><td><a href="README.c.html#func-function2">README.c</a>
<tr><td>References Variables:
<td><a href="README.c.html#var-var1">var1</a><td><a href="README.c.html#var-var1">README.c</a>
<tr><td>
<td><a href="README.c.html#var-var3">var3</a><td><a href="README.c.html#var-var3">README.c</a>
<tr><td>
<td><a href="README.c.html#var-var4">var4</a><td><a href="README.c.html#var-var4">README.c</a>
</table>
<hr>
<h2><a name="func-function2">Global Function function2()</a></h2>
An alternative function comment
<p>
<tt><a href="README.c.src.html#line112">int function2 ( int arg1, int arg2, void )</a></tt><br>
<dl compact>
<dt><tt>int function2</tt>
<dd> Returns a value
<dt><tt>int arg1</tt>
<dd> The first argument.
<dt><tt>int arg2</tt>
<dd> The second argument.
<dt><tt>void</tt>
<dd>&nbs;
</dl>
<table>
<tr><td>Called by:
<td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
<tr><td>References Functions:
<td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
</table>
</BODY>
</HTML>
|