@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
47 lines • 19.7 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Documentation generation library — The LPdoc Internals Manual</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="lpdoc-logo-128_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="lpdoc_devel_man.html">↑</a><a class="lpdoc-navbutton" href="docmaker.html">←</a><a class="lpdoc-navbutton" href="autodoc_state.html">→</a><a class="lpdoc-navbutton" href="lpdoc_devel_mansearch.html">🔍</a></span><span><a href="lpdoc_devel_manfulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="lpdoc_devel_man.html">The LPdoc Internals Manual</a> »<br/> </li><li><a href=""><strong>Documentation generation library</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on multifiles">Documentation on multifiles</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Documentation generation library</h1><a class="lpdoc-idx-anchor" href="lpdoc_devel_mansearch.html#autodoc"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Manuel Hermenegildo" href="lpdoc_devel_mansearch.html#Manuel Hermenegildo">Manuel Hermenegildo</a>, <a class="lpdoc-idx-anchor" id="Jose F. Morales" href="lpdoc_devel_mansearch.html#Jose F. Morales">Jose F. Morales</a>.<p>
<a class="lpdoc-idx-anchor" id="0" href="lpdoc_devel_mansearch.html#automatic documentation library"></a> <p>This library provides some predicates which generate documentation automatically for a given documenation component (module, package, application, etc.), using the declarations and assertions used in the source itself as input (see the <a class="lpdoc-idx-anchor" id="1" href="lpdoc_devel_mansearch.html#assertions"><tt>assertions</tt></a> library).<p>The output format <a class="lpdoc-idx-anchor" id="2" href="lpdoc_devel_mansearch.html#documentation format"></a> in which the documentation is generated is defined by the backend modules (<a class="lpdoc-idx-anchor" id="3" href="autodoc_texinfo.html"><tt>autodoc_texinfo</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="autodoc_html.html"><tt>autodoc_html</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="autodoc_man.html"><tt>autodoc_man</tt></a>, etc.). <br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(lpdoc(autodoc)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="6" href="#reset_output_dir_db/0"><tt>reset_output_dir_db/0</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#ensure_output_dir_prepared/2"><tt>ensure_output_dir_prepared/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#get_autodoc_opts/3"><tt>get_autodoc_opts/3</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#autodoc_gen_doctree/5"><tt>autodoc_gen_doctree/5</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#fmt_infodir_entry/3"><tt>fmt_infodir_entry/3</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#autodoc_compute_grefs/3"><tt>autodoc_compute_grefs/3</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#autodoc_translate_doctree/3"><tt>autodoc_translate_doctree/3</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#autodoc_is_operational/2"><tt>autodoc_is_operational/2</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="#autodoc_finish/1"><tt>autodoc_finish/1</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="#autodoc_gen_alternative/2"><tt>autodoc_gen_alternative/2</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="16" href="#autodoc_is_operational_hook/2"><tt>autodoc_is_operational_hook/2</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="#autodoc_finish_hook/1"><tt>autodoc_finish_hook/1</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="#autodoc_gen_alternative_hook/2"><tt>autodoc_gen_alternative_hook/2</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="reset_output_dir_db/0" href="lpdoc_devel_mansearch.html#reset_output_dir_db/0">reset_output_dir_db/0</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="ensure_output_dir_prepared/2" href="lpdoc_devel_mansearch.html#ensure_output_dir_prepared/2">ensure_output_dir_prepared/2</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>ensure_output_dir_prepared(Backend,Opts)</tt>
</span><p>Ensure that the output directories for backend <span class="lpdoc-var">Backend</span> are prepared.</p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="get_autodoc_opts/3" href="lpdoc_devel_mansearch.html#get_autodoc_opts/3">get_autodoc_opts/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>get_autodoc_opts(Backend,Mod,Opts)</tt>
</span><p>Get the list of documentation options <span class="lpdoc-var">Opts</span> for the <span class="lpdoc-var">FileBase</span> file.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="19" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Backend</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="20" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Mod</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="21" href="lpdoc_devel_mansearch.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Opts</span> is any term.
</span>
<li><em>The following properties should hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="22" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Backend</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="23" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Mod</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="24" href="lpdoc_devel_mansearch.html#list/2"><tt>list/2</tt></a>)</span><span><span class="lpdoc-var">Opts</span> is a list of <span class="lpdoc-var">supported_option</span>s.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_gen_doctree/5" href="lpdoc_devel_mansearch.html#autodoc_gen_doctree/5">autodoc_gen_doctree/5</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>autodoc_gen_doctree(Backend,FileBase,FileExt,Opts,Mod)</tt>
</span><p><span class="lpdoc-var">FileBase</span> is the module specifier of the source file being documented (without extension, <span class="lpdoc-var">FileExt</span> is the source extension). The output is a file whose contents document the main file, based on any assertions present in that file. The documentation is produced in the format given by <span class="lpdoc-var">Backend</span> (the name of the output file also depends on <span class="lpdoc-var">Backend</span>). The formats supported are given by <a class="lpdoc-idx-anchor" id="25" href="autodoc_state.html#backend_id/1"><tt>backend_id/1</tt></a>. <a class="lpdoc-idx-anchor" id="26" href="lpdoc_devel_mansearch.html#supported documentation formats"></a></p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="27" href="autodoc_state.html#backend_id/1"><tt>backend_id/1</tt></a>)</span><span><span class="lpdoc-var">Backend</span> is a supported backend.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="28" href="autodoc_filesystem.html#filename_noext/1"><tt>filename_noext/1</tt></a>)</span><span><span class="lpdoc-var">FileBase</span> is the base name of a file (without extension).
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="29" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">FileExt</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="30" href="lpdoc_devel_mansearch.html#list/2"><tt>list/2</tt></a>)</span><span><span class="lpdoc-var">Opts</span> is a list of <span class="lpdoc-var">supported_option</span>s.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="31" href="lpdoc_devel_mansearch.html#atm/1"><tt>atm/1</tt></a>)</span><span><span class="lpdoc-var">Mod</span> is an atom.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fmt_infodir_entry/3" href="lpdoc_devel_mansearch.html#fmt_infodir_entry/3">fmt_infodir_entry/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>fmt_infodir_entry(DocSt,Version,Mod)</tt>
</span><p>Generates a one line description (ASCII) of the application or library in a file for the directory of <tt>emacs info</tt> manuals.</p><ul class="lpdoc-itemize-minus"><li><em>The following properties should hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="33" href="autodoc_state.html#docstate/1"><tt>docstate/1</tt></a>)</span><span><a class="lpdoc-idx-anchor" id="32" href="lpdoc_devel_mansearch.html#docstate(DocSt)"><tt>docstate(DocSt)</tt></a>
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="34" href="lpdoc_devel_mansearch.html#term/1"><tt>term/1</tt></a>)</span><span><span class="lpdoc-var">Version</span> is any term.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="35" href="autodoc_filesystem.html#filename_noext/1"><tt>filename_noext/1</tt></a>)</span><span><span class="lpdoc-var">Mod</span> is the base name of a file (without extension).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_compute_grefs/3" href="lpdoc_devel_mansearch.html#autodoc_compute_grefs/3">autodoc_compute_grefs/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Compute the globally resolved references (including bibliography)</p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_translate_doctree/3" href="lpdoc_devel_mansearch.html#autodoc_translate_doctree/3">autodoc_translate_doctree/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><p>Translate the doctree using the specific backend</p><ul class="lpdoc-itemize-minus"></ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_is_operational/2" href="lpdoc_devel_mansearch.html#autodoc_is_operational/2">autodoc_is_operational/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_finish/1" href="lpdoc_devel_mansearch.html#autodoc_finish/1">autodoc_finish/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_gen_alternative/2" href="lpdoc_devel_mansearch.html#autodoc_gen_alternative/2">autodoc_gen_alternative/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div><p>
</div><div id="Documentation on multifiles"><h2>Documentation on multifiles</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_is_operational_hook/2" href="lpdoc_devel_mansearch.html#autodoc_is_operational_hook/2">autodoc_is_operational_hook/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
The predicate is <em>multifile</em>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_finish_hook/1" href="lpdoc_devel_mansearch.html#autodoc_finish_hook/1">autodoc_finish_hook/1</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
The predicate is <em>multifile</em>.<br/></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="autodoc_gen_alternative_hook/2" href="lpdoc_devel_mansearch.html#autodoc_gen_alternative_hook/2">autodoc_gen_alternative_hook/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.
The predicate is <em>multifile</em>.<br/></div></div><p>
</div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>Application modules:</em><br/><a class="lpdoc-idx-anchor" id="36" href="lpdoc_devel_mansearch.html#doccfg_props"><tt>doccfg_props</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="autodoc_state.html"><tt>autodoc_state</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="autodoc_settings.html"><tt>autodoc_settings</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="autodoc_filesystem.html"><tt>autodoc_filesystem</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="autodoc_structure.html"><tt>autodoc_structure</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="autodoc_doctree.html"><tt>autodoc_doctree</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="autodoc_refsdb.html"><tt>autodoc_refsdb</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="lpdoc_devel_mansearch.html#autodoc_parse"><tt>autodoc_parse</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="autodoc_index.html"><tt>autodoc_index</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="lpdoc_devel_mansearch.html#comments"><tt>comments</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="lpdoc_devel_mansearch.html#autodoc_messages"><tt>autodoc_messages</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="autodoc_html_assets.html"><tt>autodoc_html_assets</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="autodoc_texinfo.html"><tt>autodoc_texinfo</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="autodoc_aux.html"><tt>autodoc_aux</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="50" href="lpdoc_devel_mansearch.html#datafacts_rt"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="lpdoc_devel_mansearch.html#format"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="52" href="lpdoc_devel_mansearch.html#read"><tt>read</tt></a>, <a class="lpdoc-idx-anchor" id="53" href="lpdoc_devel_mansearch.html#aggregates"><tt>aggregates</tt></a>, <a class="lpdoc-idx-anchor" id="54" href="lpdoc_devel_mansearch.html#compiler"><tt>compiler</tt></a>, <a class="lpdoc-idx-anchor" id="55" href="lpdoc_devel_mansearch.html#assrt_lib"><tt>assrt_lib</tt></a>, <a class="lpdoc-idx-anchor" id="56" href="lpdoc_devel_mansearch.html#c_itf"><tt>c_itf</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="lpdoc_devel_mansearch.html#pathnames"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="58" href="lpdoc_devel_mansearch.html#lists"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="59" href="lpdoc_devel_mansearch.html#terms"><tt>terms</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="lpdoc_devel_mansearch.html#assertions_props"><tt>assertions_props</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="lpdoc_devel_mansearch.html#system"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="lpdoc_devel_mansearch.html#bundle_paths"><tt>bundle_paths</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="63" href="lpdoc_devel_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="64" href="lpdoc_devel_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="65" href="lpdoc_devel_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="66" href="lpdoc_devel_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="67" href="lpdoc_devel_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="68" href="lpdoc_devel_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="69" href="lpdoc_devel_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="70" href="lpdoc_devel_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="71" href="lpdoc_devel_mansearch.html#basic_props"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="72" href="lpdoc_devel_mansearch.html#hiord_rt"><tt>hiord_rt</tt></a>, <a class="lpdoc-idx-anchor" id="73" href="lpdoc_devel_mansearch.html#stream_basic"><tt>stream_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="74" href="lpdoc_devel_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="75" href="lpdoc_devel_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="76" href="lpdoc_devel_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="77" href="lpdoc_devel_mansearch.html#assertions"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="78" href="lpdoc_devel_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="79" href="lpdoc_devel_mansearch.html#regtypes"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="80" href="lpdoc_devel_mansearch.html#dcg"><tt>dcg</tt></a>, <a class="lpdoc-idx-anchor" id="81" href="lpdoc_devel_mansearch.html#basicmodes"><tt>basicmodes</tt></a>, <a class="lpdoc-idx-anchor" id="82" href="lpdoc_devel_mansearch.html#fsyntax"><tt>fsyntax</tt></a>, <a class="lpdoc-idx-anchor" id="83" href="lpdoc_devel_mansearch.html#datafacts"><tt>datafacts</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>