# File cxref.h

RCS Header: /home/amb/cxref/RCS/cxref.h 1.27 1999/01/24 16:53:48 amb Exp

C Cross Referencing & Documentation tool. Version 1.5.
Prototypes for general functions.

Included in: | comment.c
| cxref.c
| file.c
| func.c
| html.c
| latex.c
| parse-lex.c
| parse-yacc.c
| preproc.c
| rtf.c
| sgml.c
| slist.c
| type.c
| var.c
| warn-raw.c
| xref.c

## Included Files

- `#include "datatype.h"`

## Preprocessor definitions

To stop multiple inclusions.

`#define CXREF_H`

Signifies a LOCAL function / variable / include file.

`#define LOCAL 1`

Signifies a GLOBAL fuction / variable / include file.

`#define GLOBAL 2`

Signifies an EXTERNAL variable.

`#define EXTERNAL 4`

Signifies an EXTERNAL variable seen in a header file.

`#define EXTERN_H 8`

Signifies an EXTERNAL variable seen in a function file.

`#define EXTERN_F 16`

Signifies an INLINED function.

`#define INLINED 32`

Signifies that file cross references are required.

`#define XREF_FILE 1`

Signifies that function cross references are required.

`#define XREF_FUNC 2`

Signifies that variable cross references are required.

`#define XREF_VAR 4`

Signifies that type definition cross references are required.

`#define XREF_TYPE 8`

Signifies that all the above cross references are required.

`#define XREF_ALL 15`

Signifies that warnings for commetns are required.

`#define WARN_COMMENT 1`

Signifies that warnings for cross references are required.

`#define WARN_XREF 2`

Signifies that all of the above warnings are required.

`#define WARN_ALL 3`

Signifies that an index of files is needed.

`#define INDEX_FILE 1`

Signifies that an index of global functions is needed.

`#define INDEX_FUNC 2`

Signifies that an index of global variables is needed.

`#define INDEX_VAR 3`

Signifies that an index of type definitions is needed.

`#define INDEX_TYPE 4`

Signifies that a complete index of all of the above is needed.

`#define INDEX_ALL 15`