Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
toots committed Jun 6, 2020
1 parent 0c5861b commit 3bb8174
Show file tree
Hide file tree
Showing 87 changed files with 115 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="posix-base/index.html">posix-base</a> <span class="version">2.0.1</span></li>
<li><a href="posix-base/index.html">posix-base</a> <span class="version">2.0.0</span></li>
<li><a href="posix-bindings/index.html">posix-bindings</a> <span class="version">2.0.0</span></li>
<li><a href="posix-getopt/index.html">posix-getopt</a> <span class="version">2.0.0</span></li>
<li><a href="posix-signal/index.html">posix-signal</a> <span class="version">2.0.0</span></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/posix-time2/Posix_time/Itimerspec/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Itimerspec (posix-time2.Posix_time2.Itimerspec)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time2</a> &#x00BB; Itimerspec</nav><h1>Module <code>Posix_time2.Itimerspec</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = </code><code>{</code><table class="record"><tr id="type-t.it_interval" class="anchored"><td class="def field"><a href="#type-t.it_interval" class="anchor"></a><code>it_interval : <a href="../Timespec/index.html#type-t">Timespec.t</a>;</code></td></tr><tr id="type-t.it_value" class="anchored"><td class="def field"><a href="#type-t.it_value" class="anchor"></a><code>it_value : <a href="../Timespec/index.html#type-t">Timespec.t</a>;</code></td></tr></table><code>}</code></dt></dl></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Itimerspec (posix-time2.Posix_time.Itimerspec)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time</a> &#x00BB; Itimerspec</nav><h1>Module <code>Posix_time.Itimerspec</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = </code><code>{</code><table class="record"><tr id="type-t.it_interval" class="anchored"><td class="def field"><a href="#type-t.it_interval" class="anchor"></a><code>it_interval : <a href="../Timespec/index.html#type-t">Timespec.t</a>;</code></td></tr><tr id="type-t.it_value" class="anchored"><td class="def field"><a href="#type-t.it_value" class="anchor"></a><code>it_value : <a href="../Timespec/index.html#type-t">Timespec.t</a>;</code></td></tr></table><code>}</code></dt></dl></div></body></html>
2 changes: 1 addition & 1 deletion docs/posix-time2/Posix_time/Itimerval/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Itimerval (posix-time2.Posix_time2.Itimerval)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time2</a> &#x00BB; Itimerval</nav><h1>Module <code>Posix_time2.Itimerval</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = </code><code>{</code><table class="record"><tr id="type-t.it_interval" class="anchored"><td class="def field"><a href="#type-t.it_interval" class="anchor"></a><code>it_interval : <a href="../Timeval/index.html#type-t">Timeval.t</a>;</code></td></tr><tr id="type-t.it_value" class="anchored"><td class="def field"><a href="#type-t.it_value" class="anchor"></a><code>it_value : <a href="../Timeval/index.html#type-t">Timeval.t</a>;</code></td></tr></table><code>}</code></dt></dl></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Itimerval (posix-time2.Posix_time.Itimerval)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time</a> &#x00BB; Itimerval</nav><h1>Module <code>Posix_time.Itimerval</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = </code><code>{</code><table class="record"><tr id="type-t.it_interval" class="anchored"><td class="def field"><a href="#type-t.it_interval" class="anchor"></a><code>it_interval : <a href="../Timeval/index.html#type-t">Timeval.t</a>;</code></td></tr><tr id="type-t.it_value" class="anchored"><td class="def field"><a href="#type-t.it_value" class="anchor"></a><code>it_value : <a href="../Timeval/index.html#type-t">Timeval.t</a>;</code></td></tr></table><code>}</code></dt></dl></div></body></html>
2 changes: 1 addition & 1 deletion docs/posix-time2/Posix_time/Timespec/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Timespec (posix-time2.Posix_time2.Timespec)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time2</a> &#x00BB; Timespec</nav><h1>Module <code>Posix_time2.Timespec</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <span class="keyword">private</span> </code><code>{</code><table class="record"><tr id="type-t.tv_sec" class="anchored"><td class="def field"><a href="#type-t.tv_sec" class="anchor"></a><code>tv_sec : int64;</code></td></tr><tr id="type-t.tv_nsec" class="anchored"><td class="def field"><a href="#type-t.tv_nsec" class="anchor"></a><code>tv_nsec : int64;</code></td></tr></table><code>}</code></dt><dd><p>POSIX timespec time specifier with seconds and nanoseconds. A normalized value of type <code>t</code> must have a value of <code>tv_nsec</code> between <code>0</code> and <code>1000000000</code> (exclusive).</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : int64 <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>create sec nsec</code> creates a new normalized timespec with <code>sec</code> seconds and <code>nsec</code> nanoseconds.</p></dd></dl><dl><dt class="spec value" id="val-add"><a href="#val-add" class="anchor"></a><code><span class="keyword">val</span> add : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add t1 t2</code> adds the two timespec values, returning a normalized value</p></dd></dl><dl><dt class="spec value" id="val-sub"><a href="#val-sub" class="anchor"></a><code><span class="keyword">val</span> sub : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub t1 t2</code> subtracts <code>t2</code> from <code>t1</code>, creating a new normalized time value.</p></dd></dl><dl><dt class="spec value" id="val-add_sec"><a href="#val-add_sec" class="anchor"></a><code><span class="keyword">val</span> add_sec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add_sec s t</code> adds <code>s</code> seconds to <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-add_nsec"><a href="#val-add_nsec" class="anchor"></a><code><span class="keyword">val</span> add_nsec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add_sec ns t</code> adds <code>ns</code> nanoseconds to <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-sub_sec"><a href="#val-sub_sec" class="anchor"></a><code><span class="keyword">val</span> sub_sec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub_sec s t</code> subtracts <code>s</code> seconds from <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-sub_nsec"><a href="#val-sub_nsec" class="anchor"></a><code><span class="keyword">val</span> sub_nsec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub_sec ns t</code> subtracts <code>ns</code> nanoseconds from <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dd><p><code>to_string t</code> creates a string of the form &quot;sec.nsec&quot;.</p></dd></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dd><p><code>compare t1 t2</code> compares the two time values <code>t1</code> and <code>t2</code>. It returns <code>0</code> if <code>t1</code> is equal to <code>2</code>, a negative integer if <code>t1</code> is less than <code>t2</code>, and a positive integer if <code>t1</code> is greater than <code>t2</code>.</p></dd></dl></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Timespec (posix-time2.Posix_time.Timespec)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a><a href="../../index.html">posix-time2</a> &#x00BB; <a href="../index.html">Posix_time</a> &#x00BB; Timespec</nav><h1>Module <code>Posix_time.Timespec</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <span class="keyword">private</span> </code><code>{</code><table class="record"><tr id="type-t.tv_sec" class="anchored"><td class="def field"><a href="#type-t.tv_sec" class="anchor"></a><code>tv_sec : int64;</code></td></tr><tr id="type-t.tv_nsec" class="anchored"><td class="def field"><a href="#type-t.tv_nsec" class="anchor"></a><code>tv_nsec : int64;</code></td></tr></table><code>}</code></dt><dd><p>POSIX timespec time specifier with seconds and nanoseconds. A normalized value of type <code>t</code> must have a value of <code>tv_nsec</code> between <code>0</code> and <code>1000000000</code> (exclusive).</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : int64 <span>&#45;&gt;</span> int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>create sec nsec</code> creates a new normalized timespec with <code>sec</code> seconds and <code>nsec</code> nanoseconds.</p></dd></dl><dl><dt class="spec value" id="val-add"><a href="#val-add" class="anchor"></a><code><span class="keyword">val</span> add : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add t1 t2</code> adds the two timespec values, returning a normalized value</p></dd></dl><dl><dt class="spec value" id="val-sub"><a href="#val-sub" class="anchor"></a><code><span class="keyword">val</span> sub : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub t1 t2</code> subtracts <code>t2</code> from <code>t1</code>, creating a new normalized time value.</p></dd></dl><dl><dt class="spec value" id="val-add_sec"><a href="#val-add_sec" class="anchor"></a><code><span class="keyword">val</span> add_sec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add_sec s t</code> adds <code>s</code> seconds to <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-add_nsec"><a href="#val-add_nsec" class="anchor"></a><code><span class="keyword">val</span> add_nsec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>add_sec ns t</code> adds <code>ns</code> nanoseconds to <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-sub_sec"><a href="#val-sub_sec" class="anchor"></a><code><span class="keyword">val</span> sub_sec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub_sec s t</code> subtracts <code>s</code> seconds from <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-sub_nsec"><a href="#val-sub_nsec" class="anchor"></a><code><span class="keyword">val</span> sub_nsec : int64 <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>sub_sec ns t</code> subtracts <code>ns</code> nanoseconds from <code>t</code>.</p></dd></dl><dl><dt class="spec value" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span class="keyword">val</span> to_string : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dd><p><code>to_string t</code> creates a string of the form &quot;sec.nsec&quot;.</p></dd></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> int</code></dt><dd><p><code>compare t1 t2</code> compares the two time values <code>t1</code> and <code>t2</code>. It returns <code>0</code> if <code>t1</code> is equal to <code>2</code>, a negative integer if <code>t1</code> is less than <code>t2</code>, and a positive integer if <code>t1</code> is greater than <code>t2</code>.</p></dd></dl></div></body></html>
Loading

0 comments on commit 3bb8174

Please sign in to comment.