File README.c

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

Included Files

• #include <stdio.h>

• #include <math.h>

Preprocessor definitions

#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

typedef enum {...} type1

enum
{
one;	one value
two;	another value
}

Type union bar

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

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

typedef struct {...}* ptype2

See:

• Typedef type2

Global Variable var1

int var1

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

Global Variable var2

int var2

Visible in:

README.c

Global Variable var4

int var4

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

Global Variable var5

int var5

Visible in:

README.c

Global Variable var6

int var6

Visible in:

README.c

Local Variables

static int var3

Used in:

function1()

Global Function function1()

int function1 ( int arg1, int arg2 )

int function1

The return value.

int arg1

The first argument.

int arg2

The second argument.

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

Global Function function2()

int function2 ( int arg1, int arg2, void )

int function2

Returns a value

int arg1

The first argument.

int arg2

The second argument.

void