tools/cxref/README.c.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
   2
   3 <!-- This HTML file generated by cxref. -->
   4 <!-- cxref program (c) Andrew M. Bishop 1995,96,97,98,99. -->
   5
   6 <!--
   7 Cxref: /home/amb/cxref/cxref -O/home/amb/cxref/doc -NREADME -xref -latex2e -html32-src -rtf -sgml README.c
   8 CPP  : /home/amb/cxref/cpp/cxref-cpp -cxref-cpp-defines /home/amb/cxref/cpp/cxref-cpp.defines -C -dD -dI
   9 -->
  10
  11 <HTML>
  12
  13 <HEAD>
  14 <TITLE>Cross reference for README.c of README.</TITLE>
  15 </HEAD>
  16
  17 <BODY>
  18
  19 <h1><a name="file" href="README.c.src.html">File README.c</a></h1>
  20 <b>RCS Header: /home/amb/cxref/RCS/README.c 1.4 1997/05/26 11:23:40 amb Exp </b>
  21 <p>
  22
  23   A comment for the file, RCS header comments are treated specially when first.
  24 <p>
  25
  26 <hr>
  27 <h2>Included Files</h2>
  28
  29  A #include comment
  30 <p>
  31 <ul>
  32 <li><tt>#include &lt;stdio.h&gt;</tt>
  33 </ul>
  34  An alternative #include comment.
  35 <p>
  36 <ul>
  37 <li><tt>#include &lt;math.h&gt;</tt>
  38 </ul>
  39
  40 <hr>
  41 <h2>Preprocessor definitions</h2>
  42
  43  A #define comment.
  44 <p>
  45 <tt><a href="README.c.src.html#line17">#define def1</a> 1</tt><br>
  46 <p>
  47  An alternative #define comment.
  48 <p>
  49 <tt><a href="README.c.src.html#line20">#define def2</a> 2</tt><br>
  50 <p>
  51   A #define with args
  52 <p>
  53 <tt><a href="README.c.src.html#line31">#define def3</a>( arg1, arg2 )</tt><br>
  54 <dl compact>
  55 <dt><tt>arg1</tt>
  56 <dd>The first arg
  57 <dt><tt>arg2</tt>
  58 <dd>The second arg
  59 </dl>
  60 <p>
  61  An alternative #define with args.
  62 <p>
  63 <tt><a href="README.c.src.html#line36">#define def4</a>( arg1, arg2 )</tt><br>
  64 <dl compact>
  65 <dt><tt>arg1</tt>
  66 <dd> The first arg
  67 <dt><tt>arg2</tt>
  68 <dd> The second arg
  69 </dl>
  70
  71 <hr>
  72 <h2><a name="type-type1">Typedef type1</a></h2>
  73  An example typedef comment
  74 <p>
  75 <tt><a href="README.c.src.html#line43">typedef enum {...} type1</a></tt><br>
  76 <table>
  77 <tr><td><tt>enum</tt><td>&nbsp;
  78 <tr><td>&nbsp;&nbsp;&nbsp;<tt>{</tt><td>&nbsp;
  79 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>one;</tt><td> one value
  80 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>two;</tt><td> another value
  81 <tr><td>&nbsp;&nbsp;&nbsp;<tt>}</tt><td>&nbsp;
  82 </table>
  83
  84 <hr>
  85 <h2><a name="type-union-bar">Type union bar</a></h2>
  86  Nested structs and unions also work.
  87 <p>
  88 <tt><a href="README.c.src.html#line0">union bar</a></tt><br>
  89 <table>
  90 <tr><td><tt>union bar</tt><td>&nbsp;
  91 <tr><td>&nbsp;&nbsp;&nbsp;<tt>{</tt><td>&nbsp;
  92 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>char a;</tt><td> Each element
  93 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>int b;</tt><td> of a struct
  94 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>int c;</tt><td> or a union
  95 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>long d;</tt><td> can have a comment
  96 <tr><td>&nbsp;&nbsp;&nbsp;<tt>}</tt><td>&nbsp;
  97 </table>
  98
  99 <hr>
 100 <h2><a name="type-type2">Typedef type2</a></h2>
 101  Another example typedef comment,   a type that is a struct.
 102 <p>
 103 <tt><a href="README.c.src.html#line52">typedef struct {...} type2</a></tt><br>
 104 <table>
 105 <tr><td><tt>struct</tt><td>&nbsp;
 106 <tr><td>&nbsp;&nbsp;&nbsp;<tt>{</tt><td>&nbsp;
 107 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>int a;</tt><td> A variable in a struct.
 108 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>union bar</tt><td>&nbsp;
 109 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>{</tt><td>&nbsp;
 110 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>char a;</tt><td> Each element
 111 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>int b;</tt><td> of a struct
 112 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>int c;</tt><td> or a union
 113 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>long d;</tt><td> can have a comment
 114 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>}</tt><td>&nbsp;
 115 <tr><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>e;</tt><td> Nested structs and unions also work.
 116 <tr><td>&nbsp;&nbsp;&nbsp;<tt>}</tt><td>&nbsp;
 117 </table>
 118
 119 <hr>
 120 <h2><a name="type-ptype2">Typedef ptype2</a></h2>
 121  Another example typedef comment,   a pointer to a struct type.
 122 <p>
 123 <tt><a href="README.c.src.html#line52">typedef struct {...}* ptype2</a></tt><br>
 124 <dl compact>
 125 <dt>See:
 126 <dd><ul>
 127 <li><a href="#type-type2">Typedef type2</a>
 128 </ul>
 129 </dl>
 130
 131 <hr>
 132 <h2><a name="var-var1">Global Variable var1</a></h2>
 133  A leading comment only.
 134 <p>
 135 <tt><a href="README.c.src.html#line68">int var1</a></tt><br>
 136 <table>
 137 <tr><td>Visible in:
 138 <td>&nbsp;<td><a href="README.c.html#file">README.c</a>
 139 <tr><td>Used in:
 140 <td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
 141
 142 </table>
 143
 144 <hr>
 145 <h2><a name="var-var2">Global Variable var2</a></h2>
 146  A leading comment only.
 147 <p>
 148 <tt><a href="README.c.src.html#line68">int var2</a></tt><br>
 149 <table>
 150 <tr><td>Visible in:
 151 <td>&nbsp;<td><a href="README.c.html#file">README.c</a>
 152
 153 </table>
 154
 155 <hr>
 156 <h2><a name="var-var4">Global Variable var4</a></h2>
 157  A variable for   one thing.
 158 <p>
 159 <tt><a href="README.c.src.html#line75">int var4</a></tt><br>
 160 <table>
 161 <tr><td>Visible in:
 162 <td>&nbsp;<td><a href="README.c.html#file">README.c</a>
 163 <tr><td>Used in:
 164 <td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
 165
 166 </table>
 167
 168 <hr>
 169 <h2><a name="var-var5">Global Variable var5</a></h2>
 170  A variable for   a second thing.
 171 <p>
 172 <tt><a href="README.c.src.html#line76">int var5</a></tt><br>
 173 <table>
 174 <tr><td>Visible in:
 175 <td>&nbsp;<td><a href="README.c.html#file">README.c</a>
 176
 177 </table>
 178
 179 <hr>
 180 <h2><a name="var-var6">Global Variable var6</a></h2>
 181  A variable for   a third thing.
 182 <p>
 183 <tt><a href="README.c.src.html#line77">int var6</a></tt><br>
 184 <table>
 185 <tr><td>Visible in:
 186 <td>&nbsp;<td><a href="README.c.html#file">README.c</a>
 187
 188 </table>
 189
 190 <hr>
 191 <h2>Local Variables</h2>
 192
 193 <b><a name="var-var3">var3</a></b><br>
 194  A trailing comment only.
 195 <p>
 196 <tt><a href="README.c.src.html#line71">static int var3</a></tt><br>
 197 <table>
 198 <tr><td>Used in:
 199 <td><a href="#func-function1">function1()</a>
 200
 201 </table>
 202
 203 <hr>
 204 <h2><a name="func-function1">Global Function function1()</a></h2>
 205   A function comment (the comments for the args need to be separated by a blank line).
 206 <p>
 207 <tt><a href="README.c.src.html#line99">int function1 ( int arg1, int arg2 )</a></tt><br>
 208 <dl compact>
 209 <dt><tt>int function1</tt>
 210 <dd>The return value.
 211 <dt><tt>int arg1</tt>
 212 <dd>The first argument.
 213 <dt><tt>int arg2</tt>
 214 <dd>The second argument.
 215 </dl>
 216   Some more comments
 217 <br>
 218  This comment is only visible in the HTML output, and can contain HTML markup.
 219 <br>
 220  An internal comment in a function that appears as a
 221    new paragraph at the end of the comment.
 222 <p>
 223 <table>
 224 <tr><td>Calls:
 225 <td><a href="README.c.html#func-function2">function2()</a><td><a href="README.c.html#func-function2">README.c</a>
 226 <tr><td>Used in:
 227 <td><a href="README.c.html#func-function2">function2()</a><td><a href="README.c.html#func-function2">README.c</a>
 228 <tr><td>References Variables:
 229 <td><a href="README.c.html#var-var1">var1</a><td><a href="README.c.html#var-var1">README.c</a>
 230 <tr><td>&nbsp;
 231 <td><a href="README.c.html#var-var3">var3</a><td><a href="README.c.html#var-var3">README.c</a>
 232 <tr><td>&nbsp;
 233 <td><a href="README.c.html#var-var4">var4</a><td><a href="README.c.html#var-var4">README.c</a>
 234
 235 </table>
 236
 237 <hr>
 238 <h2><a name="func-function2">Global Function function2()</a></h2>
 239  An alternative function comment
 240 <p>
 241 <tt><a href="README.c.src.html#line112">int function2 ( int arg1, int arg2, void )</a></tt><br>
 242 <dl compact>
 243 <dt><tt>int function2</tt>
 244 <dd> Returns a value
 245 <dt><tt>int arg1</tt>
 246 <dd> The first argument.
 247 <dt><tt>int arg2</tt>
 248 <dd> The second argument.
 249 <dt><tt>void</tt>
 250 <dd>&nbsp;
 251 </dl>
 252 <table>
 253 <tr><td>Called by:
 254 <td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
 255 <tr><td>References Functions:
 256 <td><a href="README.c.html#func-function1">function1()</a><td><a href="README.c.html#func-function1">README.c</a>
 257
 258 </table>
 259
 260 </BODY>
 261 </HTML>