[doc] update API doc

OCamlPro · May 30, 2012 · dc24183 · dc24183
1 parent ec59f94
commit dc24183
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 12 deletions.
diff --git a/html/File.Comp.html b/html/File.Comp.html
@@ -43,7 +43,28 @@
 <pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">t -> string list</code></pre><div class="info">
 Options to give to the "make" command<br>
 </div>
-<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type">t -> string list</code></pre><div class="info">
+<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type">t -> <a href="Types.html#TYPEname">Types.name</a> list</code></pre><div class="info">
 Packages to install immediately after the creation of OCaml<br>
 </div>
+<pre><span id="VALasmlink"><span class="keyword">val</span> asmlink</span> : <code class="type">t -> string list</code></pre><div class="info">
+Linking options to give to the native code compiler<br>
+</div>
+<pre><span id="VALasmcomp"><span class="keyword">val</span> asmcomp</span> : <code class="type">t -> string list</code></pre><div class="info">
+Compilation options to give to the native code compiler<br>
+</div>
+<pre><span id="VALbytelink"><span class="keyword">val</span> bytelink</span> : <code class="type">t -> string list</code></pre><div class="info">
+Linking options to give to the bytecode compiler<br>
+</div>
+<pre><span id="VALbytecomp"><span class="keyword">val</span> bytecomp</span> : <code class="type">t -> string list</code></pre><div class="info">
+Compilation options to give to the bytecode compiler<br>
+</div>
+<pre><span id="VALasmcomp"><span class="keyword">val</span> asmcomp</span> : <code class="type">t -> string list</code></pre><div class="info">
+Linking options to give to the native code compiler<br>
+</div>
+<pre><span id="VALrequires"><span class="keyword">val</span> requires</span> : <code class="type">t -> <a href="Types.html#TYPEsection">Types.section</a> list</code></pre><div class="info">
+Libraries to link with<br>
+</div>
+<pre><span id="VALpp"><span class="keyword">val</span> pp</span> : <code class="type">t -> <a href="Types.html#TYPEppflag">Types.ppflag</a> option</code></pre><div class="info">
+Preprocessing options<br>
+</div>
 </body></html>
diff --git a/html/File.Dot_config.Section.html b/html/File.Dot_config.Section.html
@@ -4,7 +4,6 @@
 <link rel="stylesheet" href="style.css" type="text/css">
 <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
 <link rel="Start" href="index.html">
-<link rel="next" href="File.Dot_config.Library.html">
 <link rel="Up" href="File.Dot_config.html">
 <link title="Index of types" rel=Appendix href="index_types.html">
 <link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
@@ -21,16 +20,14 @@
 <link title="Repositories" rel="Chapter" href="Repositories.html">
 <link title="Run" rel="Chapter" href="Run.html">
 <link title="Solver" rel="Chapter" href="Solver.html">
-<link title="Types" rel="Chapter" href="Types.html"><title>File.Dot_config.Section</title>
+<link title="Types" rel="Chapter" href="Types.html"><title>File.Dot_config.SECTION</title>
 </head>
 <body>
 <div class="navbar">&nbsp;<a href="File.Dot_config.html">Up</a>
-&nbsp;<a href="File.Dot_config.Library.html">Next</a>
-</div>
-<center><h1>Module <a href="type_File.Dot_config.Section.html">File.Dot_config.Section</a></h1></center>
+&nbsp;</div>
+<center><h1>Module type <a href="type_File.Dot_config.SECTION.html">File.Dot_config.SECTION</a></h1></center>
 <br>
-<pre><span class="keyword">module</span> Section: <code class="type"><a href="File.Dot_config.SECTION.html">SECTION</a></code><code class="type"> </code></pre>All library and syntax sections<br>
-<hr width="100%">
+<pre><span class="keyword">module type</span> SECTION = <code class="code">sig</code> <a href="File.Dot_config.SECTION.html">..</a> <code class="code">end</code></pre><hr width="100%">
 <pre><span id="VALavailable"><span class="keyword">val</span> available</span> : <code class="type">t -> <a href="Types.html#TYPEsection">Types.section</a> list</code></pre><div class="info">
 List the available sections<br>
 </div>

diff --git a/html/Types.html b/html/Types.html
@@ -181,6 +181,26 @@
 <pre><span id="VALstring_of_variable_contents"><span class="keyword">val</span> string_of_variable_contents</span> : <code class="type"><a href="Types.html#TYPEvariable_contents">variable_contents</a> -> string</code></pre><div class="info">
 Convert the content of a variable to a string<br>
 </div>
+<br><code><span id="TYPEppflag"><span class="keyword">type</span> <code class="type"></code>ppflag</span> = </code><table class="typetable">
+<tr>
+<td align="left" valign="top" >
+<code><span class="keyword">|</span></code></td>
+<td align="left" valign="top" >
+<code><span class="constructor">Camlp4</span> <span class="keyword">of</span> <code class="type">string list</code></code></td>
+
+</tr>
+<tr>
+<td align="left" valign="top" >
+<code><span class="keyword">|</span></code></td>
+<td align="left" valign="top" >
+<code><span class="constructor">Cmd</span> <span class="keyword">of</span> <code class="type">string list</code></code></td>
+
+</tr></table>
+
+<div class="info">
+Content of <code class="code">pp</code> variables<br>
+</div>
+
 <br>
 <span id="2_Commandlinearguments"><h2>Command line arguments</h2></span><br>
 <br><code><span id="TYPEupload"><span class="keyword">type</span> <code class="type"></code>upload</span> = {</code><table class="typetable">

diff --git a/html/index_types.html b/html/index_types.html
@@ -105,6 +105,11 @@
 Subset of packages
 </div>
 </td></tr>
+<tr><td><a href="Types.html#TYPEppflag">ppflag</a> [<a href="Types.html">Types</a>]</td>
+<td><div class="info">
+Content of <code class="code">pp</code> variables
+</div>
+</td></tr>
 <tr><td align="left"><br>R</td></tr>
 <tr><td><a href="Types.html#TYPEraw">raw</a> [<a href="Types.html">Types</a>]</td>
 <td><div class="info">

diff --git a/html/index_values.html b/html/index_values.html
@@ -81,11 +81,21 @@
 Return the list of native-compiler options
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALasmcomp">asmcomp</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Compilation options to give to the native code compiler
+</div>
+</td></tr>
 <tr><td><a href="File.Dot_config.SECTION.html#VALasmlink">asmlink</a> [<a href="File.Dot_config.SECTION.html">File.Dot_config.SECTION</a>]</td>
 <td><div class="info">
 Return the list of native-code linking options
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALasmlink">asmlink</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Linking options to give to the native code compiler
+</div>
+</td></tr>
 <tr><td><a href="File_format.html#VALassoc">assoc</a> [<a href="File_format.html">File_format</a>]</td>
 <td><div class="info">
 Get the value of a field
@@ -201,11 +211,21 @@
 Return the list of bytecode-compiler options
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALbytecomp">bytecomp</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Compilation options to give to the bytecode compiler
+</div>
+</td></tr>
 <tr><td><a href="File.Dot_config.SECTION.html#VALbytelink">bytelink</a> [<a href="File.Dot_config.SECTION.html">File.Dot_config.SECTION</a>]</td>
 <td><div class="info">
 Return the list of bytecode linking options
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALbytelink">bytelink</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Linking options to give to the bytecode compiler
+</div>
+</td></tr>
 <tr><td align="left"><br>C</td></tr>
 <tr><td><a href="Types.Dirname.html#VALchdir">chdir</a> [<a href="Types.Dirname.html">Types.Dirname</a>]</td>
 <td><div class="info">
@@ -923,6 +943,11 @@
 Parse a symbol
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALpp">pp</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Preprocessing options
+</div>
+</td></tr>
 <tr><td><a href="Solver.html#VALprint_solution">print_solution</a> [<a href="Solver.html">Solver</a>]</td>
 <td><div class="info">
 Display a solution
@@ -1022,6 +1047,11 @@
 Return the build requirements
 </div>
 </td></tr>
+<tr><td><a href="File.Comp.html#VALrequires">requires</a> [<a href="File.Comp.html">File.Comp</a>]</td>
+<td><div class="info">
+Libraries to link with
+</div>
+</td></tr>
 <tr><td><a href="Solver.html#VALresolve">resolve</a> [<a href="Solver.html">Solver</a>]</td>
 <td><div class="info">
 Given a description of packages, return a solution preserving the

diff --git a/html/type_File.Comp.html b/html/type_File.Comp.html
@@ -31,5 +31,11 @@
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;src&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;configure&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;make&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;packages&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;packages&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.name&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmlink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytelink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytecomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmcomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;requires&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;pp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.ppflag&nbsp;option<br>
 <span class="keyword">end</span></code></body></html>
diff --git a/html/type_File.Dot_config.Section.html b/html/type_File.Dot_config.Section.html
@@ -17,7 +17,18 @@
 <link title="Repositories" rel="Chapter" href="Repositories.html">
 <link title="Run" rel="Chapter" href="Run.html">
 <link title="Solver" rel="Chapter" href="Solver.html">
-<link title="Types" rel="Chapter" href="Types.html"><title>File.Dot_config.Section</title>
+<link title="Types" rel="Chapter" href="Types.html"><title>File.Dot_config.SECTION</title>
 </head>
 <body>
-<code class="code"><span class="constructor">SECTION</span></code></body></html>
+<code class="code"><span class="keyword">sig</span><br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;available&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;kind&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmcomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytecomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmlink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytelink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;requires&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variable&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable_contents<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;variables&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.variable&nbsp;list<br>
+<span class="keyword">end</span></code></body></html>
diff --git a/html/type_File.html b/html/type_File.html
@@ -125,7 +125,13 @@
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;src&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;configure&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;make&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;packages&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;packages&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.name&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmlink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytelink&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;bytecomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;asmcomp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;requires&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.section&nbsp;list<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;pp&nbsp;:&nbsp;t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.ppflag&nbsp;option<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
 &nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">Dot_install</span>&nbsp;:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>

diff --git a/html/type_Types.html b/html/type_Types.html
@@ -700,6 +700,7 @@
 &nbsp;&nbsp;<span class="keyword">type</span>&nbsp;full_variable&nbsp;=&nbsp;<span class="constructor">Types</span>.<span class="constructor">Full_variable</span>.t<br>
 &nbsp;&nbsp;<span class="keyword">type</span>&nbsp;variable_contents&nbsp;=&nbsp;<span class="constructor">B</span>&nbsp;<span class="keyword">of</span>&nbsp;bool&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="constructor">S</span>&nbsp;<span class="keyword">of</span>&nbsp;string<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;string_of_variable_contents&nbsp;:&nbsp;<span class="constructor">Types</span>.variable_contents&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;string<br>
+&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;ppflag&nbsp;=&nbsp;<span class="constructor">Camlp4</span>&nbsp;<span class="keyword">of</span>&nbsp;string&nbsp;list&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="constructor">Cmd</span>&nbsp;<span class="keyword">of</span>&nbsp;string&nbsp;list<br>
 &nbsp;&nbsp;<span class="keyword">type</span>&nbsp;upload&nbsp;=&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;opam&nbsp;:&nbsp;<span class="constructor">Types</span>.filename;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;descr&nbsp;:&nbsp;<span class="constructor">Types</span>.filename;<br>