Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@tuong
tuong committed May 22, 2012
1 parent 50f9346 commit 1543e31
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 2 deletions.
5 changes: 4 additions & 1 deletion html/File.Subst.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
<hr width="100%">
<pre><span class="keyword">include</span> <a href="File.IO_FILE.html">File.IO_FILE</a></pre>
<pre><span id="VALreplace"><span class="keyword">val</span> replace</span> : <code class="type">t -> (<a href="Types.html#TYPEfull_variable">Types.full_variable</a> -> <a href="Types.html#TYPEvariable_contents">Types.variable_contents</a>) -> t</code></pre><div class="info">
Substitute the variable appearing in a file<br>
Substitute the variables appearing in a file<br>
</div>
<pre><span id="VALreplace_string"><span class="keyword">val</span> replace_string</span> : <code class="type">string -> (<a href="Types.html#TYPEfull_variable">Types.full_variable</a> -> <a href="Types.html#TYPEvariable_contents">Types.variable_contents</a>) -> string</code></pre><div class="info">
Substitute the variables appearing in a string<br>
</div>
</body></html>
7 changes: 7 additions & 0 deletions html/Path.C.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@
<pre><span id="VALlib_dir"><span class="keyword">val</span> lib_dir</span> : <code class="type"><a href="Path.C.html#TYPEt">t</a> -> <a href="Types.html#TYPEdirname">Types.dirname</a></code></pre><div class="info">
Library path: <i>$opam/$OVERSION/lib/</i><br>
</div>
<pre><span id="VALdoc"><span class="keyword">val</span> doc</span> : <code class="type"><a href="Path.C.html#TYPEt">t</a> -> Types.N.t -> <a href="Types.html#TYPEdirname">Types.dirname</a></code></pre><div class="info">
Documentation path for a given package:
<i>$opam/$OVERSION/doc/NAME</i><br>
</div>
<pre><span id="VALdoc_dir"><span class="keyword">val</span> doc_dir</span> : <code class="type"><a href="Path.C.html#TYPEt">t</a> -> <a href="Types.html#TYPEdirname">Types.dirname</a></code></pre><div class="info">
Documentation path: <i>$opam/$OVERSION/doc/</i><br>
</div>
<pre><span id="VALbin"><span class="keyword">val</span> bin</span> : <code class="type"><a href="Path.C.html#TYPEt">t</a> -> <a href="Types.html#TYPEdirname">Types.dirname</a></code></pre><div class="info">
Installed binaries: <i>$opam/$OVERSION/bin</i><br>
</div>
Expand Down
18 changes: 17 additions & 1 deletion html/index_values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,17 @@
Return the directory name
</div>
</td></tr>
<tr><td><a href="Path.C.html#VALdoc">doc</a> [<a href="Path.C.html">Path.C</a>]</td>
<td><div class="info">
Documentation path for a given package:
<i>$opam/$OVERSION/doc/NAME</i>
</div>
</td></tr>
<tr><td><a href="Path.C.html#VALdoc_dir">doc_dir</a> [<a href="Path.C.html">Path.C</a>]</td>
<td><div class="info">
Documentation path: <i>$opam/$OVERSION/doc/</i>
</div>
</td></tr>
<tr><td><a href="Repositories.html#VALdownload">download</a> [<a href="Repositories.html">Repositories</a>]</td>
<td><div class="info">
Run <i>opam-$kind-download</i> in <i>$opam/repo/$repo</i>
Expand Down Expand Up @@ -961,7 +972,12 @@
</td></tr>
<tr><td><a href="File.Subst.html#VALreplace">replace</a> [<a href="File.Subst.html">File.Subst</a>]</td>
<td><div class="info">
Substitute the variable appearing in a file
Substitute the variables appearing in a file
</div>
</td></tr>
<tr><td><a href="File.Subst.html#VALreplace_string">replace_string</a> [<a href="File.Subst.html">File.Subst</a>]</td>
<td><div class="info">
Substitute the variables appearing in a string
</div>
</td></tr>
<tr><td><a href="Path.G.html#VALrepo_index">repo_index</a> [<a href="Path.G.html">Path.G</a>]</td>
Expand Down
2 changes: 2 additions & 0 deletions html/type_File.Subst.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,6 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;to_raw&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.raw<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;of_raw&nbsp;:&nbsp;<span class="constructor">Types</span>.raw&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;replace&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;(<span class="constructor">Types</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable_contents)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;replace_string&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;(<span class="constructor">Types</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable_contents)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
<span class="keyword">end</span></code></body></html>
2 changes: 2 additions & 0 deletions html/type_File.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,5 +197,7 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;of_raw&nbsp;:&nbsp;<span class="constructor">Types</span>.raw&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;replace&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;(<span class="constructor">Types</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable_contents)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;t<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;replace_string&nbsp;:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;(<span class="constructor">Types</span>.full_variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable_contents)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
<span class="keyword">end</span></code></body></html>
2 changes: 2 additions & 0 deletions html/type_Path.C.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;root&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;lib&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">N</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;lib_dir&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;doc&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">N</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;doc_dir&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bin&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;installed&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.filename<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;build&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">NV</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
Expand Down
2 changes: 2 additions & 0 deletions html/type_Path.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;root&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;lib&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">N</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;lib_dir&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;doc&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">N</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;doc_dir&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bin&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;installed&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.filename<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;build&nbsp;:&nbsp;<span class="constructor">Path</span>.<span class="constructor">C</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">NV</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.dirname<br>
Expand Down

0 comments on commit 1543e31

Please sign in to comment.