Cross reference for README.c of README-TMP.

# File README.c

RCS Header: /home/amb/CVS/cxref/doc/README.c,v 1.4 1997-05-26 11:23:40 amb Exp

A comment for the file, RCS header comments are treated specially when first.

## Included Files

A #include comment

- #include <stdio.h>

An alternative #include comment.

- #include <math.h>

## Preprocessor definitions

A #define comment.
#define def1 1

An alternative #define comment.
#define def2 2

A #define with args
#define def3( arg1, arg2 )

arg1
  The first arg
arg2
  The second arg

An alternative #define with args.
#define def4( arg1, arg2 )

arg1
  The first arg
arg2
  The second arg

## Typedef type1

An example typedef comment
typedef enum {...} type1

enum |
{ |
one; | one value
two; | another value
} |

## Type union bar

Nested structs and unions also work.
union bar

union bar |
{ |
char a; | Each element
int b; | of a struct
int c; | or a union
long d; | can have a comment
} |

## Typedef type2

Another example typedef comment, a type that is a struct.
typedef struct {...} type2

struct |
{ |
int a; | A variable in a struct.
union bar |
{ |
char a; | Each element
int b; | of a struct
int c; | or a union
long d; | can have a comment
} |
e; | Nested structs and unions also work.
} |

## Typedef ptype2

Another example typedef comment, a pointer to a struct type.
typedef struct {...}* ptype2

See: | Typedef type2

## Global Variable var1

A leading comment only.
int var1

Visible in: |  | README.c
Used in: | function1() | README.c

## Global Variable var2

A leading comment only.
int var2

Visible in: |  | README.c

## Global Variable var4

A variable for one thing.
int var4

Visible in: |  | README.c
Used in: | function1() | README.c

## Global Variable var5

A variable for a second thing.
int var5

Visible in: |  | README.c

## Global Variable var6

A variable for a third thing.
int var6

Visible in: |  | README.c

## Local Variables

var3

A trailing comment only.
static int var3

Used in: | function1() |

## Global Function function1()

A function comment (the comments for the args need to be separated by a blank line).
int function1 ( int arg1, int arg2 )

int function1
  The return value.
int arg1
  The first argument.
int arg2
  The second argument.

Some more comments
This comment is only visible in the HTML output, and can contain HTML markup.
An internal comment in a function that appears as a new paragraph at the end of the comment.

Calls: | function2() | README.c
Used in: | function2() | README.c
References Variables: | var1 | README.c
| var3 | README.c
| var4 | README.c

## Global Function function2()

An alternative function comment
int function2 ( int arg1, int arg2, void )

int function2
  Returns a value
int arg1
  The first argument.
int arg2
  The second argument.
void

Called by: | function1() | README.c
References Functions: | function1() | README.c