[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /obj/handlers/autodoc/autodoc_file.c</h2>
The automatic document generator.  It takes source files from various
directories and creates help files from the comments embeded in the
code.
<p><b>See also:</b><br><a href="obj.handlers.autodoc.autodoc_handler.c.shtml">/obj/handlers/autodoc/autodoc_handler.c</a><p>Written by Pinkfish<p>Started Fri Oct 24 16:03:57 EDT 1997
<h2>Method index</h2>
<dl><ul>
<li><a href="#load_file">load_file</a>()<br/>
Loads up the currently set file name from the archives.
<li><a href="#parse_file">parse_file</a>(string, function, int)<br/>
Parses the input file figuring out all the documentation bits of it.
<li><a href="#query_changed">query_changed</a>()<br/>
Did the file change?
<li><a href="#query_class_docs">query_class_docs</a>()<br/>
The documentation for the classes.
<li><a href="#query_define_docs">query_define_docs</a>()<br/>
The documentation for the defines.
<li><a href="#query_defines">query_defines</a>()<br/>
The defines which were setup in the class.
<li><a href="#query_file_name">query_file_name</a>()<br/>
The file name being processed.
<li><a href="#query_includes">query_includes</a>()<br/>
The files included by this one.
<li><a href="#query_inherits">query_inherits</a>()<br/>
Returns the inherits mapping of the system.
<li><a href="#query_main_docs">query_main_docs</a>()<br/>
Returns the main docs for the class.
<li><a href="#query_num_failed_tries">query_num_failed_tries</a>()<br/>
This method returns the number of times the file was attempted to
be read and it was discovered not to exist at all.
<li><a href="#query_private_functions">query_private_functions</a>()<br/>
The mapping of private functions.
<li><a href="#query_protected_functions">query_protected_functions</a>()<br/>
The mapping of protected functions.
<li><a href="#query_public_functions">query_public_functions</a>()<br/>
The mapping of public functions.
<li><a href="#save_file">save_file</a>()<br/>
Saves the current file name to the archives.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="load_file">
load_file</a><pre>
void load_file()
</pre></br>
Loads up the currently set file name from the archives.


<ul><a name="parse_file">
parse_file</a><pre>
void parse_file(string name,
                function func,
                int only_load)
</pre></br>
Parses the input file figuring out all the documentation bits of it.

<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the file to parse
<br/>func - the function to call when the parsing is finished
<br/>only_load - a flag telling us to only load the information

</dl>

<ul><a name="query_changed">
query_changed</a><pre>
int query_changed()
</pre></br>
Did the file change?  Checks to see if the file changed since it
was last read.

<br/><ul>
<li><b>Returns:</b>
<br/>1 if it changed, 0 if it has not changed

</dl>

<ul><a name="query_class_docs">
query_class_docs</a><pre>
mapping query_class_docs()
</pre></br>
The documentation for the classes.
<br/><ul>
<li><b>Returns:</b>
<br/>the mapping of the class names to documentation

</dl>

<ul><a name="query_define_docs">
query_define_docs</a><pre>
mapping query_define_docs()
</pre></br>
The documentation for the defines.  This is mostly used by the include
file documentation system.

<br/><ul>
<li><b>Returns:</b>
<br/>the mapping of define names to documentation

</dl>

<ul><a name="query_defines">
query_defines</a><pre>
mapping query_defines()
</pre></br>
The defines which were setup in the class.  This is the mapping of the
defines which were processed.  The format of the mapping is
([ "name" : "value" ]), where the name is the name of the define and
the value is what to replace it with.

<br/><ul>
<li><b>Returns:</b>
<br/>the mapping of defines

</dl>

<ul><a name="query_file_name">
query_file_name</a><pre>
string query_file_name()
</pre></br>
The file name being processed.

<br/><ul>
<li><b>Returns:</b>
<br/>the name of the file being processed

</dl>

<ul><a name="query_includes">
query_includes</a><pre>
string * query_includes()
</pre></br>
The files included by this one.

<br/><ul>
<li><b>Returns:</b>
<br/>an array of included files

</dl>

<ul><a name="query_inherits">
query_inherits</a><pre>
mapping query_inherits()
</pre></br>
Returns the inherits mapping of the system.  This returns a mapping of the
form ([ inherit_name : ({ flags }) ]).  Where the name of the inherit is
something like "/std/object" and the flags are things you can apply to
an inherit, like "protected" or "private".  If there are no flags then
the flags will be an empty array.

<br/><ul>
<li><b>Returns:</b>
<br/>a mapping of things inherited by this file

</dl>

<ul><a name="query_main_docs">
query_main_docs</a><pre>
mapping query_main_docs()
</pre></br>
Returns the main docs for the class.  The mapping is of
the form ([ "tag" : ({ data }) ]), where each reference
to a tag creates a new element in the data array.

<br/><ul>
<li><b>Returns:</b>
<br/>a mapping containing the main docs for the file

</dl>

<ul><a name="query_num_failed_tries">
query_num_failed_tries</a><pre>
int query_num_failed_tries()
</pre></br>
This method returns the number of times the file was attempted to
be read and it was discovered not to exist at all.
<br/><ul>
<li><b>Returns:</b>
<br/>the number of times it was unable to be read

</dl>

<ul><a name="query_private_functions">
query_private_functions</a><pre>
mapping query_private_functions()
</pre></br>
The mapping of private functions.
The mapping is of the form ([ func_name : ({ type, args, docs }) ]).
The type bit is an array of the type name, ie: ({ "int" }) or
({ "mixed", "*" }).  The args bit looks like ({ "name", type }),
where the type is the same as in the previous array.  The docs is
a mapping of the form ([ "tag" : ({ data }) ]), where each reference
to a tag creates a new element in the data array.

<br/><ul>
<li><b>Returns:</b>
<br/>a mapping containing the private functions

</dl>

<ul><a name="query_protected_functions">
query_protected_functions</a><pre>
mapping query_protected_functions()
</pre></br>
The mapping of protected functions.
The mapping is of the form ([ func_name : ({ type, args, docs }) ]).
The type bit is an array of the type name, ie: ({ "int" }) or
({ "mixed", "*" }).  The args bit looks like ({ "name", type }),
where the type is the same as in the previous array.  The docs is
a mapping of the form ([ "tag" : ({ data }) ]), where each reference
to a tag creates a new element in the data array.

<br/><ul>
<li><b>Returns:</b>
<br/>a mapping containing the protected functions

</dl>

<ul><a name="query_public_functions">
query_public_functions</a><pre>
mapping query_public_functions()
</pre></br>
The mapping of public functions.
The mapping is of the form ([ func_name : ({ type, args, docs }) ]).
The type bit is an array of the type name, ie: ({ "int" }) or
({ "mixed", "*" }).  The args bit looks like ({ "name", type }),
where the type is the same as in the previous array.  The docs is
a mapping of the form ([ "tag" : ({ data }) ]), where each reference
to a tag creates a new element in the data array.

<br/><ul>
<li><b>Returns:</b>
<br/>a mapping containing the public functions

</dl>

<ul><a name="save_file">
save_file</a><pre>
void save_file()
</pre></br>
Saves the current file name to the archives.



[an error occurred while processing this directive]