% This LaTeX file generated by cxref
% cxref program (c) Andrew M. Bishop 1995,96,97.

\markboth{File cxref.h}{File cxref.h}
\section{File cxref.h}
\label{file_cxref.h}

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

\smallskip

  C Cross Referencing \& Documentation tool. Version 1.5.

  Prototypes for general functions.

\medskip
\begin{cxreftabii}
Included in:\ & comment.c & \cxreffile{comment.c}\\
\ & cxref.c & \cxreffile{cxref.c}\\
\ & file.c & \cxreffile{file.c}\\
\ & func.c & \cxreffile{func.c}\\
\cxreftabbreak{cxreftabii}
\ & html.c & \cxreffile{html.c}\\
\ & latex.c & \cxreffile{latex.c}\\
\ & parse-lex.c & \cxreffile{parse-lex.c}\\
\ & parse-yacc.c & \cxreffile{parse-yacc.c}\\
\ & preproc.c & \cxreffile{preproc.c}\\
\ & rtf.c & \cxreffile{rtf.c}\\
\ & sgml.c & \cxreffile{sgml.c}\\
\ & slist.c & \cxreffile{slist.c}\\
\cxreftabbreak{cxreftabii}
\ & type.c & \cxreffile{type.c}\\
\ & var.c & \cxreffile{var.c}\\
\ & warn-raw.c & \cxreffile{warn-raw.c}\\
\ & xref.c & \cxreffile{xref.c}\\
\end{cxreftabii}


\subsection*{Included Files}

\begin{cxreftabi}
{\stt \#include "datatype.h"} &\cxreffile{datatype.h}\\
\end{cxreftabi}


\subsection*{Preprocessor definitions}

 To stop multiple inclusions. 

\smallskip
{\stt \#define CXREF\_H}

\medskip
 Signifies a LOCAL function / variable / include file. 

\smallskip
{\stt \#define LOCAL 1}

\medskip
 Signifies a GLOBAL fuction / variable / include file. 

\smallskip
{\stt \#define GLOBAL 2}

\medskip
 Signifies an EXTERNAL variable. 

\smallskip
{\stt \#define EXTERNAL 4}

\medskip
 Signifies an EXTERNAL variable seen in a header file. 

\smallskip
{\stt \#define EXTERN\_H 8}

\medskip
 Signifies an EXTERNAL variable seen in a function file. 

\smallskip
{\stt \#define EXTERN\_F 16}

\medskip
 Signifies an INLINED function. 

\smallskip
{\stt \#define INLINED 32}

\medskip
 Signifies that file cross references are required. 

\smallskip
{\stt \#define XREF\_FILE 1}

\medskip
 Signifies that function cross references are required. 

\smallskip
{\stt \#define XREF\_FUNC 2}

\medskip
 Signifies that variable cross references are required. 

\smallskip
{\stt \#define XREF\_VAR 4}

\medskip
 Signifies that type definition cross references are required. 

\smallskip
{\stt \#define XREF\_TYPE 8}

\medskip
 Signifies that all the above cross references are required. 

\smallskip
{\stt \#define XREF\_ALL 15}

\medskip
 Signifies that warnings for commetns are required. 

\smallskip
{\stt \#define WARN\_COMMENT 1}

\medskip
 Signifies that warnings for cross references are required. 

\smallskip
{\stt \#define WARN\_XREF 2}

\medskip
 Signifies that all of the above warnings are required. 

\smallskip
{\stt \#define WARN\_ALL 3}

\medskip
 Signifies that an index of files is needed. 

\smallskip
{\stt \#define INDEX\_FILE 1}

\medskip
 Signifies that an index of global functions is needed. 

\smallskip
{\stt \#define INDEX\_FUNC 2}

\medskip
 Signifies that an index of global variables is needed. 

\smallskip
{\stt \#define INDEX\_VAR 3}

\medskip
 Signifies that an index of type definitions is needed. 

\smallskip
{\stt \#define INDEX\_TYPE 4}

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

\smallskip
{\stt \#define INDEX\_ALL 15}

