Skip to content

Commit

Permalink
[ docs ] CI docs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 23, 2024
1 parent 7389d88 commit 1614fb9
Show file tree
Hide file tree
Showing 23 changed files with 1,201 additions and 307 deletions.
2 changes: 1 addition & 1 deletion docs/cozippable/docs/docs/Data.Cozippable.html

Large diffs are not rendered by default.

323 changes: 168 additions & 155 deletions docs/cozippable/docs/docs/Data.Cozippable.src.html

Large diffs are not rendered by default.

68 changes: 68 additions & 0 deletions docs/fin-lizzie/docs/docs/Data.Fin.Map.html

Large diffs are not rendered by default.

333 changes: 333 additions & 0 deletions docs/fin-lizzie/docs/docs/Data.Fin.Map.src.html

Large diffs are not rendered by default.

69 changes: 69 additions & 0 deletions docs/fin-lizzie/docs/docs/Data.Fin.Set.html

Large diffs are not rendered by default.

288 changes: 288 additions & 0 deletions docs/fin-lizzie/docs/docs/Data.Fin.Set.src.html

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions docs/fin-lizzie/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,19 @@
</div>
</div>
</li><li>
<div class="index-wrapper">
<div class="index-namespace-url">
<a class="code" href="docs/Data.Fin.Map.html">Data.Fin.Map</a>
</div>
<div class="index-namespace-doc">
Specialised map from `Fin`s to any type.
Isomorphic to a vector of appropriate size of maybe's of appropriate type.

This should be a replacement for `SortedMap (Fin n) v` working better at least in elaborator scripts.

</div>
</div>
</li><li>
<div class="index-wrapper">
<div class="index-namespace-url">
<a class="code" href="docs/Data.Fin.Minus.html">Data.Fin.Minus</a>
Expand All @@ -82,6 +95,20 @@
</div>
</div>
</li><li>
<div class="index-wrapper">
<div class="index-namespace-url">
<a class="code" href="docs/Data.Fin.Set.html">Data.Fin.Set</a>
</div>
<div class="index-namespace-doc">
Specialised set of `Fin`s.
Isomorphic to a vector of appropriate size of booleans.

This should be a replacement for `SortedSet (Fin n)` working better at least in elaborator scripts.
This can be implemented as simple `Integer` setting and clearing bits, but this seems to work worse in elaborator scripts.

</div>
</div>
</li><li>
<div class="index-wrapper">
<div class="index-namespace-url">
<a class="code" href="docs/Data.Fin.ToFin.html">Data.Fin.ToFin</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rtlsdr/docs/docs/Bindings.RtlSdr.Buffer.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@
</script>

</header>
<div class="container"><div id="module-header"><h1>Bindings.RtlSdr.Buffer</h1><span style="float:right">(<a href="Bindings.RtlSdr.Buffer.src.html">source</a>)</span><pre></pre></div><h2>Reexports</h2><code><span class="keyword">import</span>&ensp;<span class="keyword">public</span>&ensp;Bindings.RtlSdr.Raw.Buffer</code><h2>Definitions</h2><dl class="decls"><dt id="Bindings.RtlSdr.Buffer.resetBuffer"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.resetBuffer"><span class="name function">resetBuffer</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.readSync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.readSync"><span class="name function">readSync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.AnyPtr"><span class="name type">AnyPtr</span></span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;<span class="name type">Int</span>)</code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.ReadAsyncFn"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.ReadAsyncFn"><span class="name function">ReadAsyncFn</span></a>&ensp;:&ensp;<span class="name type">Type</span></code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">public&ensp;export</span></dd><dt id="Bindings.RtlSdr.Buffer.readAsync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.readAsync"><span class="name function">readAsync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.ReadAsyncFn"><span class="name function">ReadAsyncFn</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.AnyPtr"><span class="name type">AnyPtr</span></span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.cancelAsync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.cancelAsync"><span class="name function">cancelAsync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd></dl></div><footer>Produced by Idris 2 version 0.7.0-f3dca12a5</footer></body></html>
<div class="container"><div id="module-header"><h1>Bindings.RtlSdr.Buffer</h1><span style="float:right">(<a href="Bindings.RtlSdr.Buffer.src.html">source</a>)</span><pre></pre></div><h2>Reexports</h2><code><span class="keyword">import</span>&ensp;<span class="keyword">public</span>&ensp;Bindings.RtlSdr.Raw.Buffer</code><h2>Definitions</h2><dl class="decls"><dt id="Bindings.RtlSdr.Buffer.resetBuffer"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.resetBuffer"><span class="name function">resetBuffer</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.readSync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.readSync"><span class="name function">readSync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.AnyPtr"><span class="name type">AnyPtr</span></span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;<span class="name type">Int</span>)</code></dt><dd><pre> Read samples from the device synchronously.<br> <br> @h is the device handle<br> @b a pointer to a buffer to write samples to<br> @l the length of the buffer</pre><br> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.ReadAsyncFn"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.ReadAsyncFn"><span class="name function">ReadAsyncFn</span></a>&ensp;:&ensp;<span class="name type">Type</span></code></dt><dd><pre> Call callback closure type signature</pre><br> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">public&ensp;export</span></dd><dt id="Bindings.RtlSdr.Buffer.readAsync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.readAsync"><span class="name function">readAsync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.ReadAsyncFn"><span class="name function">ReadAsyncFn</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.AnyPtr"><span class="name type">AnyPtr</span></span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="name type">Int</span>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd><pre> Read samples from the device asynchronously. This will block until<br> it is being canceled using `cancelAsync`.<br> <br> @h is the device handle<br> @cbIO is the callback closure to received samples<br> @ctx is a user defined context to pass to the callback closure<br> @bn optional buffer count, buf_num * buf_len = overall buffer size<br> set to 0 for default buffer count (15)<br> @bl optional buffer length, must be multiple of 512,<br> should be a multiple of 16384 (URB size), set to 0<br> for default buffer length (16 * 32 * 512)</pre><br> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd><dt id="Bindings.RtlSdr.Buffer.cancelAsync"><code><a class="type" href="Bindings.RtlSdr.Buffer.html#Bindings.RtlSdr.Buffer.cancelAsync"><span class="name function">cancelAsync</span></a>&ensp;:&ensp;<span class="type resolved" title="PrimIO.Ptr"><span class="name type">Ptr</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Raw.Device.html#Bindings.RtlSdr.Raw.Device.RtlSdrHandle"><span class="name type">RtlSdrHandle</span></a>&ensp;<span class="keyword">-&gt;</span>&ensp;<span class="type resolved" title="PrimIO.IO"><span class="name type">IO</span></span>&ensp;(<span class="type resolved" title="Prelude.Types.Either"><span class="name type">Either</span></span>&ensp;<a class="type" href="Bindings.RtlSdr.Error.html#Bindings.RtlSdr.Error.RTLSDR_ERROR"><span class="name type">RTLSDR_ERROR</span></a>&ensp;())</code></dt><dd><pre> Cancel all pending asynchronous operations on the device.<br> <br> @h is the device handle</pre><br> <b>Totality</b>:&ensp;<span class="keyword">total</span><br> <b>Visibility</b>:&ensp;<span class="keyword">export</span></dd></dl></div><footer>Produced by Idris 2 version 0.7.0-f3dca12a5</footer></body></html>
Loading

0 comments on commit 1614fb9

Please sign in to comment.