<!DOCTYPE LINUXDOC SYSTEM>

<!-- This SGML file generated by cxref. -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98. -->

<article>

<title>Cross reference for cxref.h of cxref.
<author>cxref

<sect>File cxref.h
<bf>RCS Header: /home/amb/cxref/RCS/cxref.h 1.27 1999/01/24 16:53:48 amb Exp </bf>
<p>

  C Cross Referencing &amp; Documentation tool. Version 1.5.
<newline>
  Prototypes for general functions.
<p>
<p>
<descrip>
<tag>Included in:</tag>
<itemize>
<item>comment.c
<item>cxref.c
<item>file.c
<item>func.c
<item>html.c
<item>latex.c
<item>parse-lex.c
<item>parse-yacc.c
<item>preproc.c
<item>rtf.c
<item>sgml.c
<item>slist.c
<item>type.c
<item>var.c
<item>warn-raw.c
<item>xref.c
</itemize>
</descrip>

<sect1>Included Files

<p>
<itemize>
<item><tt>#include &quot;datatype.h&quot;</tt>
</itemize>

<sect1>Preprocessor definitions

<p>
 To stop multiple inclusions. 
<p>
<tt>#define CXREF_H</tt><newline>
<p>
 Signifies a LOCAL function / variable / include file. 
<p>
<tt>#define LOCAL 1</tt><newline>
<p>
 Signifies a GLOBAL fuction / variable / include file. 
<p>
<tt>#define GLOBAL 2</tt><newline>
<p>
 Signifies an EXTERNAL variable. 
<p>
<tt>#define EXTERNAL 4</tt><newline>
<p>
 Signifies an EXTERNAL variable seen in a header file. 
<p>
<tt>#define EXTERN_H 8</tt><newline>
<p>
 Signifies an EXTERNAL variable seen in a function file. 
<p>
<tt>#define EXTERN_F 16</tt><newline>
<p>
 Signifies an INLINED function. 
<p>
<tt>#define INLINED 32</tt><newline>
<p>
 Signifies that file cross references are required. 
<p>
<tt>#define XREF_FILE 1</tt><newline>
<p>
 Signifies that function cross references are required. 
<p>
<tt>#define XREF_FUNC 2</tt><newline>
<p>
 Signifies that variable cross references are required. 
<p>
<tt>#define XREF_VAR 4</tt><newline>
<p>
 Signifies that type definition cross references are required. 
<p>
<tt>#define XREF_TYPE 8</tt><newline>
<p>
 Signifies that all the above cross references are required. 
<p>
<tt>#define XREF_ALL 15</tt><newline>
<p>
 Signifies that warnings for commetns are required. 
<p>
<tt>#define WARN_COMMENT 1</tt><newline>
<p>
 Signifies that warnings for cross references are required. 
<p>
<tt>#define WARN_XREF 2</tt><newline>
<p>
 Signifies that all of the above warnings are required. 
<p>
<tt>#define WARN_ALL 3</tt><newline>
<p>
 Signifies that an index of files is needed. 
<p>
<tt>#define INDEX_FILE 1</tt><newline>
<p>
 Signifies that an index of global functions is needed. 
<p>
<tt>#define INDEX_FUNC 2</tt><newline>
<p>
 Signifies that an index of global variables is needed. 
<p>
<tt>#define INDEX_VAR 3</tt><newline>
<p>
 Signifies that an index of type definitions is needed. 
<p>
<tt>#define INDEX_TYPE 4</tt><newline>
<p>
 Signifies that a complete index of all of the above is needed. 
<p>
<tt>#define INDEX_ALL 15</tt><newline>

</article>
