<!DOCTYPE LINUXDOC SYSTEM>

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

<article>

<title>Cross reference for file.c of cxref.
<author>cxref

<sect>File file.c
<bf>RCS Header: /home/amb/cxref/RCS/file.c 1.10 1997/05/17 15:06:01 amb Exp </bf>
<p>

  C Cross Referencing &amp; Documentation tool. Version 1.4.
<newline>
  Sets up the top level File structure.
<p>

<sect1>Included Files

<p>
<itemize>
<item><tt>#include &lt;stdlib.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &lt;stdio.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &lt;string.h&gt;</tt>
</itemize>
<itemize>
<item><tt>#include &quot;memory.h&quot;</tt>
</itemize>
<itemize>
<item><tt>#include &quot;datatype.h&quot;</tt>
</itemize>
<itemize>
<item><tt>#include &quot;cxref.h&quot;</tt>
<itemize>
<item><tt>#include &quot;datatype.h&quot;</tt>
</itemize>
</itemize>

<sect1>Preprocessor definitions

<p>
 To control the debugging in this file. 
<p>
<tt>#define DEBUG 0</tt><newline>

<sect1>External Variables

<p>
<bf>CurFile</bf><newline>
 This contains the File that is currently being documented to allow the other functions access to it. 
<p>
<tt>extern File CurFile</tt><newline>
<descrip>
<tag>Defined in:</tag>
<itemize>
<item>CurFile</itemize>
</descrip>

<sect1>Global Function DeleteFile()

<p>  Deletes a file structure.
<p>
<tt>void DeleteFile ( File file )</tt><newline>
<descrip>
<tag><tt>File file</tt></tag>
The file structure to be deleted.
</descrip>
  This is required to go through each of the elements in the File structure and delete each of them in turn.
<p>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>DeleteDefineType()  :  preproc.c
<item>DeleteFunctionType()  :  func.c
<item>DeleteIncludeType()  :  preproc.c
<item>DeleteStringList()  :  slist.c
<item>DeleteStringList2()  :  slist.c
<item>DeleteTypedefType()  :  type.c
<item>DeleteVariableType()  :  var.c
<item>SafeFree()  :  memory.c
</itemize>
<tag>Called by:</tag>
<itemize>
<item>main()  :  cxref.c
</itemize>
</descrip>

<sect1>Global Function NewFile()

<p>  Creates a new File structure.
<p>
<tt>File NewFile ( char* name )</tt><newline>
<descrip>
<tag><tt>File NewFile</tt></tag>
Returns the new file structure.
<tag><tt>char* name</tt></tag>
The name of the file.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>NewStringList()  :  slist.c
<item>NewStringList2()  :  slist.c
<item>SafeCalloc()  :  memory.c
<item>SafeMallocString()  :  memory.c
</itemize>
<tag>Called by:</tag>
<itemize>
<item>main()  :  cxref.c
</itemize>
</descrip>

<sect1>Global Function SeenFileComment()

<p>  Called when a file comment has been seen. Only the first of multiple comments in a file are used.
<p>
<tt>void SeenFileComment ( char* comment )</tt><newline>
<descrip>
<tag><tt>char* comment</tt></tag>
The comment for the file.
</descrip>
<descrip>
<tag>Prototyped in:</tag>
<itemize>
<item>cxref.h
</itemize>
<tag>Calls:</tag>
<itemize>
<item>SafeMallocString()  :  memory.c
</itemize>
<tag>Called by:</tag>
<itemize>
<item>SeenComment()  :  comment.c
</itemize>
<tag>References Variables:</tag>
<itemize>
<item>CurFile  :  cxref.c
</itemize>
</descrip>

</article>
