Permalink
Browse files

Add missing library and tools API HTML files

  • Loading branch information...
pmoura committed Jan 4, 2018
1 parent 097672d commit 021a9a572c3ec9e0f6a03bba651b7f754bce4ab1
Showing with 443 additions and 0 deletions.
  1. +263 −0 docs/code_metric_0.html
  2. +180 −0 docs/either_0.html
View
@@ -0,0 +1,263 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<?xml-stylesheet href="logtalk.css" type="text/css"?><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<title>code_metric</title>
<link rel="stylesheet" href="logtalk.css" type="text/css"/>
</head>
<body>
<div class="header">
<p class="type">category</p>
<h1 class="code">code_metric</h1>
<blockquote>
<p class="comment">Logtalk frontend for analyzing source code via metrics.</p>
</blockquote>
</div>
<div class="entity">
<div class="section">
<dl class="properties">
<dt class="key">author:</dt>
<dd class="value">
<code>Ebrahim Azarisooreh and Paulo Moura</code>
</dd>
<dt class="key">version:</dt>
<dd class="value">
<code>0.7</code>
</dd>
<dt class="key">date:</dt>
<dd class="value">
<code>2018/1/1</code>
</dd>
</dl>
<dl class="properties">
<dt class="key">compilation flags:</dt>
<dd class="value">
<code>static</code>
</dd>
</dl>
<p class="comment">(no dependencies on other entities)</p>
</div>
</div>
<div class="predicates">
<div class="public">
<h2>Public interface</h2>
<div class="section">
<h3 id="entity/1" class="code">entity/1</h3>
<blockquote>
<p class="comment">Scans an entity and prints a summary based on all applicable metrics.</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>entity(Entity)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>entity(+term) &ndash; zero_or_one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="file/1" class="code">file/1</h3>
<blockquote>
<p class="comment">Prints a metric summary of all entities defined in a source file.</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>file(File)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>file(+atom) &ndash; zero_or_one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="directory/1" class="code">directory/1</h3>
<blockquote>
<p class="comment">Scans a directory and prints metrics summary for all its 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>directory(Directory)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>directory(+atom) &ndash; one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="rdirectory/1" class="code">rdirectory/1</h3>
<blockquote>
<p class="comment">Recursive version of directory/1.</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>rdirectory(Directory)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>rdirectory(+atom) &ndash; one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="library/1" class="code">library/1</h3>
<blockquote>
<p class="comment">Prints a metrics summary of all loaded entities from a given library.</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>library(Library)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>library(+atom) &ndash; one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="rlibrary/1" class="code">rlibrary/1</h3>
<blockquote>
<p class="comment">Recursive version of library/1.</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>rlibrary(Library)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>rlibrary(+atom) &ndash; one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="all/0" class="code">all/0</h3>
<blockquote>
<p class="comment">Scans all loaded entities and prints a report of all applicable metrics.</p>
</blockquote>
<dl class="properties">
<dt class="key">compilation flags:</dt>
<dd class="value">
<code>static</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>all &ndash; one</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="entity_score/2" class="code">entity_score/2</h3>
<blockquote>
<p class="comment">Score is a term that represents the metric score associated with Entity. Fails if the metric does not apply.</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>entity_score(Entity,Score)</code>
</dd>
</dl>
</div>
<div class="section">
<h3 id="entity_score//2" class="code">entity_score//2</h3>
<blockquote>
<p class="comment">Pretty prints the entity score.</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>entity_score(Entity,Score)</code>
</dd>
</dl>
</div>
</div>
<div class="protected">
<h2>Protected interface</h2>
<div class="section">
<h3 id="process_entity/2" class="code">process_entity/2</h3>
<blockquote>
<p class="comment">Processes an entity of the given kind. Fails if the metric does not apply.</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>process_entity(Kind,Entity)</code>
</dd>
<dt class="key">mode &ndash; number of proofs:</dt>
<dd class="value">
<code>process_entity(+atom,@entity_identifier) &ndash; one</code>
</dd>
</dl>
</div>
</div>
<div class="private">
<h2>Private predicates</h2>
<div class="section">
<p class="comment">(none)</p>
</div>
</div>
</div>
<div class="operators">
<h2>Operators</h2>
<div class="section">
<h3 class="comment">(none)</h3>
</div>
</div>
<div class="remarks">
<h2>Remarks</h2>
<div class="section">
<h3 class="comment">(none)</h3>
</div>
</div>
<div class="see_also">
<h2>See also</h2>
<div class="section">
<h3 class="comment">(none)</h3>
</div>
</div>
</body>
</html>
Oops, something went wrong.

0 comments on commit 021a9a5

Please sign in to comment.