Skip to content

Commit

Permalink
Update HTML documentation for some of the developer tools
Browse files Browse the repository at this point in the history
  • Loading branch information
pmoura committed Jul 23, 2014
1 parent 3312958 commit 1d8fc9e
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/diagram_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1 class="code">diagram(Format)</h1>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2014/5/16</code>
<code>2014/7/23</code>
</dd>
</dl>
<dl class="properties">
Expand Down
2 changes: 1 addition & 1 deletion docs/diagrams_tool.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ <h1>Diagrams tool</h1>
<li><a href="xref_diagram_0.html">xref_diagram</a></li>
<li><a href="xref_diagram_1.html">xref_diagram/1</a></li>
</ul>
<p>Generated on Seg 7 Jul 2014 14:37:56 WEST</p>
<p>Generated on Qui 24 Jul 2014 00:30:48 WEST</p>
</body>
</html>
10 changes: 5 additions & 5 deletions docs/help_0.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h3 id="completions/2" class="code">completions/2</h3>
<div class="section">
<h3 id="built_in_directive/4" class="code">built_in_directive/4</h3>
<blockquote>
<p class="comment">Provides acess to the HTML documenting files describing built-in directives.</p>
<p class="comment">Provides access to the HTML documenting files describing built-in directives.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -161,7 +161,7 @@ <h3 id="built_in_directive/4" class="code">built_in_directive/4</h3>
<div class="section">
<h3 id="built_in_predicate/4" class="code">built_in_predicate/4</h3>
<blockquote>
<p class="comment">Provides acess to the HTML documenting files describing built-in predicates.</p>
<p class="comment">Provides access to the HTML documenting files describing built-in predicates.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -181,7 +181,7 @@ <h3 id="built_in_predicate/4" class="code">built_in_predicate/4</h3>
<div class="section">
<h3 id="built_in_method/4" class="code">built_in_method/4</h3>
<blockquote>
<p class="comment">Provides acess to the HTML documenting files describing built-in methods.</p>
<p class="comment">Provides access to the HTML documenting files describing built-in methods.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -201,7 +201,7 @@ <h3 id="built_in_method/4" class="code">built_in_method/4</h3>
<div class="section">
<h3 id="control/4" class="code">control/4</h3>
<blockquote>
<p class="comment">Provides acess to the HTML documenting files describing built-in control constructs.</p>
<p class="comment">Provides access to the HTML documenting files describing built-in control constructs.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -221,7 +221,7 @@ <h3 id="control/4" class="code">control/4</h3>
<div class="section">
<h3 id="built_in_non_terminal/4" class="code">built_in_non_terminal/4</h3>
<blockquote>
<p class="comment">Provides acess to the HTML documenting files describing built-in DCG non-terminals.</p>
<p class="comment">Provides access to the HTML documenting files describing built-in DCG non-terminals.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/help_tool.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ <h1>Help tool</h1>
<ul>
<li><a href="help_0.html">help</a></li>
</ul>
<p>Generated on Seg 7 Jul 2014 15:42:33 WEST</p>
<p>Generated on Qui 24 Jul 2014 00:30:48 WEST</p>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/lgtunit_messages_0.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1 class="code">lgtunit_messages</h1>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2013/11/29</code>
<code>2014/7/8</code>
</dd>
</dl>
<dl class="properties">
Expand Down
28 changes: 24 additions & 4 deletions docs/prolog_modules_diagram_support_0.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ <h1 class="code">prolog_modules_diagram_support</h1>
</dd>
<dt class="key">version:</dt>
<dd class="value">
<code>0.5</code>
<code>0.8</code>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2014/5/16</code>
<code>2014/7/23</code>
</dd>
</dl>
<dl class="properties">
Expand All @@ -45,7 +45,7 @@ <h2>Public interface</h2>
<div class="section">
<h3 id="module_property/2" class="code">module_property/2</h3>
<blockquote>
<p class="comment">Access to module properties, at least exports/1 and file/1.</p>
<p class="comment">Access to module properties, at least exports/1 and file/1 but also calls/2 and provides/3 when possible.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -65,7 +65,7 @@ <h3 id="module_property/2" class="code">module_property/2</h3>
<div class="section">
<h3 id="loaded_file_property/2" class="code">loaded_file_property/2</h3>
<blockquote>
<p class="comment">Access to loaded source file properties, at least basename/1, directory/1, and parent/1.</p>
<p class="comment">Access to loaded source file properties, at least basename/1, directory/1 but also parent/1 when possible.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
Expand All @@ -82,6 +82,26 @@ <h3 id="loaded_file_property/2" class="code">loaded_file_property/2</h3>
</dd>
</dl>
</div>
<div class="section">
<h3 id="source_file_extension/1" class="code">source_file_extension/1</h3>
<blockquote>
<p class="comment">Valid source file extension for Prolog source files.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
<dd class="value">
<code>static</code>
</dd>
<dt class="key">template:</dt>
<dd class="value">
<code>source_file_extension(Extension)</code>
</dd>
<dt class="key">mode &ndash; number of solutions:</dt>
<dd class="value">
<code>source_file_extension(?atom) &ndash; one_or_more</code>
</dd>
</dl>
</div>
</div>
<div class="protected">
<h2>Protected interface</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/xref_diagram_1.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h1 class="code">xref_diagram(Format)</h1>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2014/6/18</code>
<code>2014/7/20</code>
</dd>
</dl>
<dl class="properties">
Expand Down
4 changes: 2 additions & 2 deletions tools/diagrams/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ Support for displaying Prolog modules and Prolog module files in diagrams:
- SICStus Prolog
file diagrams don't display module files
- SWI-Prolog
full support
full support (uses the SWI-Prolog `prolog_xref` library)
- YAP
full support
full support (uses the YAP `prolog_xref` library)

For more information on this tool, open the `docs/tools.html` file in a
web browser.
Expand Down
6 changes: 3 additions & 3 deletions tools/diagrams/prolog_modules_diagram_support.lgt
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@
:- public(module_property/2).
:- mode(module_property(?atom, ?callable), zero_or_more).
:- info(module_property/2, [
comment is 'Access to module properties, at least exports/1 and file/1.',
comment is 'Access to module properties, at least exports/1 and file/1 but also calls/2 and provides/3 when possible.',
argnames is ['Module', 'Property']
]).

:- public(loaded_file_property/2).
:- mode(loaded_file_property(?atom, ?callable), zero_or_more).
:- info(loaded_file_property/2, [
comment is 'Access to loaded source file properties, at least basename/1, directory/1, and parent/1.',
comment is 'Access to loaded source file properties, at least basename/1, directory/1 but also parent/1 when possible.',
argnames is ['File', 'Property']
]).

:- public(source_file_extension/1).
:- mode(source_file_extension(?atom), one_or_more).
:- info(source_file_extension/1, [
comment is 'Valid source file extension for Prolog source files',
comment is 'Valid source file extension for Prolog source files.',
argnames is ['Extension']
]).

Expand Down

0 comments on commit 1d8fc9e

Please sign in to comment.