@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
26 lines • 10.8 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>Driver for documentation generation — 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="lpdoc_devel_manintro.html">←</a><a class="lpdoc-navbutton" href="autodoc.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>Driver for documentation generation</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>Driver for documentation generation</h1><a class="lpdoc-idx-anchor" href="lpdoc_devel_mansearch.html#docmaker"></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>
This module implements the main driver for documentation generation.<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(docmaker)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="0" href="#doc_cmd/3"><tt>doc_cmd/3</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="1" href="#fsmemo.key/2"><tt>fsmemo.key/2</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#fsmemo.deps/2"><tt>fsmemo.deps/2</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#fsmemo.run/1"><tt>fsmemo.run/1</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="doc_cmd/3" href="lpdoc_devel_mansearch.html#doc_cmd/3">doc_cmd/3</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>doc_cmd(InFile,Opts,Cmd)</tt>
</span><p>Treat according to <span class="lpdoc-var">Cmd</span> <span class="lpdoc-var">InFile</span> (which can be a <a class="lpdoc-idx-anchor" id="4" href="lpdoc_devel_mansearch.html#doccfg"><tt>doccfg</tt></a>-file or standalone file). <span class="lpdoc-var">Opts</span> is the list of options (see <a class="lpdoc-idx-anchor" id="5" href="autodoc_settings.html#autodoc_option/1"><tt>autodoc_option/1</tt></a>).</p><ul class="lpdoc-itemize-minus"></ul></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="fsmemo.key/2" href="lpdoc_devel_mansearch.html#fsmemo.key/2">fsmemo.key/2</a></div><div class="lpdoc-deftext">
The predicate is <em>multifile</em>.<br/><p><span class="lpdoc-usage-header">Module entry condition:</span><span class="lpdoc-usage-decl"><tt>fsmemo.key(Action,Arg2)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="6" href="lpdoc_devel_mansearch.html#ground/1"><tt>ground/1</tt></a>)</span><span><span class="lpdoc-var">Action</span> is currently ground (it contains no variables).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fsmemo.deps/2" href="lpdoc_devel_mansearch.html#fsmemo.deps/2">fsmemo.deps/2</a></div><div class="lpdoc-deftext">
The predicate is <em>multifile</em>.<br/><p><span class="lpdoc-usage-header">Module entry condition:</span><span class="lpdoc-usage-decl"><tt>fsmemo.deps(Action,Arg2)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="7" href="lpdoc_devel_mansearch.html#ground/1"><tt>ground/1</tt></a>)</span><span><span class="lpdoc-var">Action</span> is currently ground (it contains no variables).
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="fsmemo.run/1" href="lpdoc_devel_mansearch.html#fsmemo.run/1">fsmemo.run/1</a></div><div class="lpdoc-deftext">
The predicate is <em>multifile</em>.<br/><p><span class="lpdoc-usage-header">Module entry condition:</span><span class="lpdoc-usage-decl"><tt>fsmemo.run(Action)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold at call time:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="8" href="lpdoc_devel_mansearch.html#ground/1"><tt>ground/1</tt></a>)</span><span><span class="lpdoc-var">Action</span> is currently ground (it contains no variables).
</span>
</ul></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="9" href="autodoc.html"><tt>autodoc</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="autodoc_state.html"><tt>autodoc_state</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="autodoc_images.html"><tt>autodoc_images</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="autodoc_structure.html"><tt>autodoc_structure</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="autodoc_settings.html"><tt>autodoc_settings</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="autodoc_filesystem.html"><tt>autodoc_filesystem</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="autodoc_texinfo.html"><tt>autodoc_texinfo</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="lpdoc_devel_mansearch.html#autodoc_messages"><tt>autodoc_messages</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="lpdoc_devel_mansearch.html#docmod_holder"><tt>docmod_holder</tt></a>.
<li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="18" href="lpdoc_devel_mansearch.html#format"><tt>format</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="lpdoc_devel_mansearch.html#aggregates"><tt>aggregates</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="lpdoc_devel_mansearch.html#compiler"><tt>compiler</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="lpdoc_devel_mansearch.html#lists"><tt>lists</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="lpdoc_devel_mansearch.html#stream_utils"><tt>stream_utils</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="lpdoc_devel_mansearch.html#pathnames"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="lpdoc_devel_mansearch.html#fsmemo_rt"><tt>fsmemo_rt</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="lpdoc_devel_mansearch.html#port_reify"><tt>port_reify</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="lpdoc_devel_mansearch.html#system"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="lpdoc_devel_mansearch.html#opendoc"><tt>opendoc</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="lpdoc_devel_mansearch.html#read"><tt>read</tt></a>.
<li><em>Internal (engine) modules:</em><br/><a class="lpdoc-idx-anchor" id="29" href="lpdoc_devel_mansearch.html#term_basic"><tt>term_basic</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="lpdoc_devel_mansearch.html#arithmetic"><tt>arithmetic</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="lpdoc_devel_mansearch.html#atomic_basic"><tt>atomic_basic</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="lpdoc_devel_mansearch.html#basiccontrol"><tt>basiccontrol</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="lpdoc_devel_mansearch.html#exceptions"><tt>exceptions</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="lpdoc_devel_mansearch.html#term_compare"><tt>term_compare</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="lpdoc_devel_mansearch.html#term_typing"><tt>term_typing</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="lpdoc_devel_mansearch.html#debugger_support"><tt>debugger_support</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="lpdoc_devel_mansearch.html#basic_props"><tt>basic_props</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="lpdoc_devel_mansearch.html#hiord_rt"><tt>hiord_rt</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="lpdoc_devel_mansearch.html#internals"><tt>internals</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="lpdoc_devel_mansearch.html#stream_basic"><tt>stream_basic</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="41" href="lpdoc_devel_mansearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="lpdoc_devel_mansearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="lpdoc_devel_mansearch.html#condcomp"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="lpdoc_devel_mansearch.html#assertions"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="lpdoc_devel_mansearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="lpdoc_devel_mansearch.html#regtypes"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="lpdoc_devel_mansearch.html#dcg"><tt>dcg</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="lpdoc_devel_mansearch.html#basicmodes"><tt>basicmodes</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="lpdoc_devel_mansearch.html#fsyntax"><tt>fsyntax</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="lpdoc_devel_mansearch.html#fsmemo"><tt>fsmemo</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>