Permalink
Browse files

[doc] update API

  • Loading branch information...
1 parent d03256d commit 2f28df32b8862d4b5d817d2ab439b195030290b3 @tuong tuong committed Aug 3, 2012
Showing with 9 additions and 4 deletions.
  1. +6 −4 doc/html/Solver.html
  2. +3 −0 doc/html/type_Solver.html
View
@@ -176,16 +176,18 @@
For the ordering, the first element in the list
is obtained by upgrading from its next element.<br>
</div>
-<pre><span id="VALfilter_backward_dependencies"><span class="keyword">val</span> filter_backward_dependencies</span> : <code class="type"><a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
+<pre><span id="VALfilter_backward_dependencies"><span class="keyword">val</span> filter_backward_dependencies</span> : <code class="type">?depopts:bool -> <a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
Return the recursive dependencies of a package Note : the given
package exists in the list in input because this list describes
- the entire universe. By convention, it also appears in output.<br>
+ the entire universe. By convention, it also appears in output.
+ If <code class="code">depopts</code> (= <code class="code">false</code> by default) is set to <code class="code">true</code>,
+ optional dependencies are merged with usual dependencies.<br>
</div>
-<pre><span id="VALfilter_forward_dependencies"><span class="keyword">val</span> filter_forward_dependencies</span> : <code class="type"><a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
+<pre><span id="VALfilter_forward_dependencies"><span class="keyword">val</span> filter_forward_dependencies</span> : <code class="type">?depopts:bool -> <a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
Same as <code class="code">filter_backward_dependencies</code> but for forward
dependencies<br>
</div>
-<pre><span id="VALsort_by_backward_dependencies"><span class="keyword">val</span> sort_by_backward_dependencies</span> : <code class="type"><a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
+<pre><span id="VALsort_by_backward_dependencies"><span class="keyword">val</span> sort_by_backward_dependencies</span> : <code class="type">?depopts:bool -> <a href="Solver.html#TYPEuniverse">universe</a> -> <a href="Solver.html#TYPEpackages">packages</a> -> <a href="Solver.html#TYPEpackage">package</a> list</code></pre><div class="info">
Return a permutation of the given set of packages :
if package B depends of package A then
B appears before A in the resulting list<br>
@@ -180,9 +180,12 @@
&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Solver</span>.universe&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Solver</span>.request&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Types</span>.<span class="constructor">NV</span>.<span class="constructor">Set</span>.t&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.solution&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;filter_backward_dependencies&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;?depopts:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Solver</span>.universe&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.packages&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.package&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;filter_forward_dependencies&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;?depopts:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Solver</span>.universe&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.packages&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.package&nbsp;list<br>
&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;sort_by_backward_dependencies&nbsp;:<br>
+&nbsp;&nbsp;&nbsp;&nbsp;?depopts:bool&nbsp;<span class="keywordsign">-&gt;</span><br>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Solver</span>.universe&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.packages&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Solver</span>.package&nbsp;list<br>
<span class="keyword">end</span></code></body></html>

0 comments on commit 2f28df3

Please sign in to comment.