Cross reference for README.c of README-TMP. <author>cxref <sect>File README.c <bf>RCS Header: /home/amb/cxref/doc/RCS/README.c 1.4 1997/05/26 11:23:40 amb Exp </bf> A comment for the file, RCS header comments are treated specially when first. <sect1>Included Files A #include comment <itemize> <item><tt>#include <stdio.h></tt> </itemize> An alternative #include comment. <itemize> <item><tt>#include <math.h></tt> </itemize> <sect1>Preprocessor definitions A #define comment. <tt>#define def1 1</tt><newline> An alternative #define comment. <tt>#define def2 2</tt><newline> A #define with args <tt>#define def3( arg1, arg2 )</tt><newline> <descrip> <tag><tt>arg1</tt></tag> The first arg <tag><tt>arg2</tt></tag> The second arg </descrip> An alternative #define with args. <tt>#define def4( arg1, arg2 )</tt><newline> <descrip> <tag><tt>arg1</tt></tag> The first arg <tag><tt>arg2</tt></tag> The second arg </descrip> <sect1>Typedef type1 An example typedef comment <tt>typedef enum {...} type1</tt><newline> <itemize> <item><tt>enum</tt><newline> <itemize> <item><tt>{</tt><newline> <item><tt>one; </tt> one value <newline> <item><tt>two; </tt> another value <newline> <item><tt>}</tt><newline> </itemize> </itemize> <sect1>Type union bar Nested structs and unions also work. <itemize> <item><tt>union bar</tt><newline> <itemize> <item><tt>{</tt><newline> <item><tt>char a; </tt> Each element <newline> <item><tt>int b; </tt> of a struct <newline> <item><tt>int c; </tt> or a union <newline> <item><tt>long d; </tt> can have a comment <newline> <item><tt>}</tt><newline> </itemize> </itemize> <sect1>Typedef type2 Another example typedef comment, a type that is a struct. <tt>typedef struct {...} type2</tt><newline> <itemize> <item><tt>struct</tt><newline> <itemize> <item><tt>{</tt><newline> <item><tt>int a; </tt> A variable in a struct. <newline> <item><tt>union bar</tt><newline> <itemize> <item><tt>{</tt><newline> <item><tt>char a; </tt> Each element <newline> <item><tt>int b; </tt> of a struct <newline> <item><tt>int c; </tt> or a union <newline> <item><tt>long d; </tt> can have a comment <newline> <item><tt>}</tt><newline> </itemize> <item><tt>e; </tt> Nested structs and unions also work. <newline> <item><tt>}</tt><newline> </itemize> </itemize> <sect1>Typedef ptype2 Another example typedef comment, a pointer to a struct type. <tt>typedef struct {...}* ptype2</tt><newline> <descrip> <tag>See:</tag> <itemize> <item>Typedef type2 </itemize> </descrip> <sect1>Global Variable var1 A leading comment only. <tt>int var1</tt><newline> <descrip> <tag>Visible in:</tag> <itemize> <item>README.c </itemize> <tag>Used in:</tag> <itemize> <item>function1() : README.c </itemize> </descrip> <sect1>Global Variable var2 A leading comment only. <tt>int var2</tt><newline> <descrip> <tag>Visible in:</tag> <itemize> <item>README.c </itemize> </descrip> <sect1>Global Variable var4 A variable for one thing. <tt>int var4</tt><newline> <descrip> <tag>Visible in:</tag> <itemize> <item>README.c </itemize> <tag>Used in:</tag> <itemize> <item>function1() : README.c </itemize> </descrip> <sect1>Global Variable var5 A variable for a second thing. <tt>int var5</tt><newline> <descrip> <tag>Visible in:</tag> <itemize> <item>README.c </itemize> </descrip> <sect1>Global Variable var6 A variable for a third thing. <tt>int var6</tt><newline> <descrip> <tag>Visible in:</tag> <itemize> <item>README.c </itemize> </descrip> <sect1>Local Variables <bf>var3</bf><newline> A trailing comment only. <tt>static int var3</tt><newline> <descrip> <tag>Used in:</tag> <itemize> <item>function1() </itemize> </descrip> <sect1>Global Function function1() A function comment (the comments for the args need to be separated by a blank line). <tt>int function1 ( int arg1, int arg2 )</tt><newline> <descrip> <tag><tt>int function1</tt></tag> The return value. <tag><tt>int arg1</tt></tag> The first argument. <tag><tt>int arg2</tt></tag> The second argument. </descrip> Some more comments <newline> <newline> An internal comment in a function that appears as a new paragraph at the end of the comment. <descrip> <tag>Calls:</tag> <itemize> <item>function2() : README.c </itemize> <tag>Used in:</tag> <itemize> <item>function2() : README.c </itemize> <tag>References Variables:</tag> <itemize> <item>var1 : README.c <item>var3 : README.c <item>var4 : README.c </itemize> </descrip> <sect1>Global Function function2() An alternative function comment <tt>int function2 ( int arg1, int arg2, void )</tt><newline> <descrip> <tag><tt>int function2</tt></tag> Returns a value <tag><tt>int arg1</tt></tag> The first argument. <tag><tt>int arg2</tt></tag> The second argument. <tag><tt>void</tt></tag> </descrip> <descrip> <tag>Called by:</tag> <itemize> <item>function1() : README.c </itemize> <tag>References Functions:</tag> <itemize> <item>function1() : README.c </itemize> </descrip> </article>