tools/cxref/README.c.sgml

   1 <!DOCTYPE LINUXDOC SYSTEM>
   2
   3 <!-- This SGML 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 <article>
  12
  13 <title>Cross reference for README.c of README.
  14 <author>cxref
  15
  16 <sect>File README.c
  17 <bf>RCS Header: /home/amb/cxref/RCS/README.c 1.4 1997/05/26 11:23:40 amb Exp </bf>
  18 <p>
  19
  20   A comment for the file, RCS header comments are treated specially when first.
  21 <p>
  22
  23 <sect1>Included Files
  24
  25 <p>
  26  A &num;include comment
  27 <p>
  28 <itemize>
  29 <item><tt>#include &lt;stdio.h&gt;</tt>
  30 </itemize>
  31  An alternative &num;include comment.
  32 <p>
  33 <itemize>
  34 <item><tt>#include &lt;math.h&gt;</tt>
  35 </itemize>
  36
  37 <sect1>Preprocessor definitions
  38
  39 <p>
  40  A &num;define comment.
  41 <p>
  42 <tt>#define def1 1</tt><newline>
  43 <p>
  44  An alternative &num;define comment.
  45 <p>
  46 <tt>#define def2 2</tt><newline>
  47 <p>
  48   A &num;define with args
  49 <p>
  50 <tt>#define def3( arg1, arg2 )</tt><newline>
  51 <descrip>
  52 <tag><tt>arg1</tt></tag>
  53 The first arg
  54 <tag><tt>arg2</tt></tag>
  55 The second arg
  56 </descrip>
  57 <p>
  58  An alternative &num;define with args.
  59 <p>
  60 <tt>#define def4( arg1, arg2 )</tt><newline>
  61 <descrip>
  62 <tag><tt>arg1</tt></tag>
  63  The first arg
  64 <tag><tt>arg2</tt></tag>
  65  The second arg
  66 </descrip>
  67
  68 <sect1>Typedef type1
  69
  70 <p>
  71  An example typedef comment
  72 <p>
  73 <tt>typedef enum {...} type1</tt><newline>
  74 <itemize>
  75 <item><tt>enum</tt><newline>
  76 <itemize>
  77 <item><tt>{</tt><newline>
  78 <item><tt>one;      </tt> one value <newline>
  79 <item><tt>two;      </tt> another value <newline>
  80 <item><tt>}</tt><newline>
  81 </itemize>
  82 </itemize>
  83
  84 <sect1>Type union bar
  85
  86 <p>
  87  Nested structs and unions also work.
  88 <p>
  89 <itemize>
  90 <item><tt>union bar</tt><newline>
  91 <itemize>
  92 <item><tt>{</tt><newline>
  93 <item><tt>char a;      </tt> Each element <newline>
  94 <item><tt>int b;      </tt> of a struct <newline>
  95 <item><tt>int c;      </tt> or a union <newline>
  96 <item><tt>long d;      </tt> can have a comment <newline>
  97 <item><tt>}</tt><newline>
  98 </itemize>
  99 </itemize>
 100
 101 <sect1>Typedef type2
 102
 103 <p>
 104  Another example typedef comment,   a type that is a struct.
 105 <p>
 106 <tt>typedef struct {...} type2</tt><newline>
 107 <itemize>
 108 <item><tt>struct</tt><newline>
 109 <itemize>
 110 <item><tt>{</tt><newline>
 111 <item><tt>int a;      </tt> A variable in a struct. <newline>
 112 <item><tt>union bar</tt><newline>
 113 <itemize>
 114 <item><tt>{</tt><newline>
 115 <item><tt>char a;      </tt> Each element <newline>
 116 <item><tt>int b;      </tt> of a struct <newline>
 117 <item><tt>int c;      </tt> or a union <newline>
 118 <item><tt>long d;      </tt> can have a comment <newline>
 119 <item><tt>}</tt><newline>
 120 </itemize>
 121 <item><tt>e;      </tt> Nested structs and unions also work. <newline>
 122 <item><tt>}</tt><newline>
 123 </itemize>
 124 </itemize>
 125
 126 <sect1>Typedef ptype2
 127
 128 <p>
 129  Another example typedef comment,   a pointer to a struct type.
 130 <p>
 131 <tt>typedef struct {...}* ptype2</tt><newline>
 132 <descrip>
 133 <tag>See:</tag>
 134 <itemize>
 135 <item>Typedef type2
 136 </itemize>
 137 </descrip>
 138
 139 <sect1>Global Variable var1
 140
 141 <p>
 142  A leading comment only.
 143 <p>
 144 <tt>int var1</tt><newline>
 145 <descrip>
 146 <tag>Visible in:</tag>
 147 <itemize>
 148 <item>README.c
 149 </itemize>
 150 <tag>Used in:</tag>
 151 <itemize>
 152 <item>function1()  :  README.c
 153 </itemize>
 154 </descrip>
 155
 156 <sect1>Global Variable var2
 157
 158 <p>
 159  A leading comment only.
 160 <p>
 161 <tt>int var2</tt><newline>
 162 <descrip>
 163 <tag>Visible in:</tag>
 164 <itemize>
 165 <item>README.c
 166 </itemize>
 167 </descrip>
 168
 169 <sect1>Global Variable var4
 170
 171 <p>
 172  A variable for   one thing.
 173 <p>
 174 <tt>int var4</tt><newline>
 175 <descrip>
 176 <tag>Visible in:</tag>
 177 <itemize>
 178 <item>README.c
 179 </itemize>
 180 <tag>Used in:</tag>
 181 <itemize>
 182 <item>function1()  :  README.c
 183 </itemize>
 184 </descrip>
 185
 186 <sect1>Global Variable var5
 187
 188 <p>
 189  A variable for   a second thing.
 190 <p>
 191 <tt>int var5</tt><newline>
 192 <descrip>
 193 <tag>Visible in:</tag>
 194 <itemize>
 195 <item>README.c
 196 </itemize>
 197 </descrip>
 198
 199 <sect1>Global Variable var6
 200
 201 <p>
 202  A variable for   a third thing.
 203 <p>
 204 <tt>int var6</tt><newline>
 205 <descrip>
 206 <tag>Visible in:</tag>
 207 <itemize>
 208 <item>README.c
 209 </itemize>
 210 </descrip>
 211
 212 <sect1>Local Variables
 213
 214 <p>
 215 <bf>var3</bf><newline>
 216  A trailing comment only.
 217 <p>
 218 <tt>static int var3</tt><newline>
 219 <descrip>
 220 <tag>Used in:</tag>
 221 <itemize>
 222 <item>function1()
 223 </itemize>
 224 </descrip>
 225
 226 <sect1>Global Function function1()
 227
 228 <p>  A function comment (the comments for the args need to be separated by a blank line).
 229 <p>
 230 <tt>int function1 ( int arg1, int arg2 )</tt><newline>
 231 <descrip>
 232 <tag><tt>int function1</tt></tag>
 233 The return value.
 234 <tag><tt>int arg1</tt></tag>
 235 The first argument.
 236 <tag><tt>int arg2</tt></tag>
 237 The second argument.
 238 </descrip>
 239   Some more comments
 240 <newline>
 241 <newline>
 242  An internal comment in a function that appears as a
 243    new paragraph at the end of the comment.
 244 <p>
 245 <descrip>
 246 <tag>Calls:</tag>
 247 <itemize>
 248 <item>function2()  :  README.c
 249 </itemize>
 250 <tag>Used in:</tag>
 251 <itemize>
 252 <item>function2()  :  README.c
 253 </itemize>
 254 <tag>References Variables:</tag>
 255 <itemize>
 256 <item>var1  :  README.c
 257 <item>var3  :  README.c
 258 <item>var4  :  README.c
 259 </itemize>
 260 </descrip>
 261
 262 <sect1>Global Function function2()
 263
 264 <p> An alternative function comment
 265 <p>
 266 <tt>int function2 ( int arg1, int arg2, void )</tt><newline>
 267 <descrip>
 268 <tag><tt>int function2</tt></tag>
 269  Returns a value
 270 <tag><tt>int arg1</tt></tag>
 271  The first argument.
 272 <tag><tt>int arg2</tt></tag>
 273  The second argument.
 274 <tag><tt>void</tt></tag>
 275 &nbsp;
 276 </descrip>
 277 <descrip>
 278 <tag>Called by:</tag>
 279 <itemize>
 280 <item>function1()  :  README.c
 281 </itemize>
 282 <tag>References Functions:</tag>
 283 <itemize>
 284 <item>function1()  :  README.c
 285 </itemize>
 286 </descrip>
 287
 288 </article>