Skip to content

Commit

Permalink
Language-ext documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@louthy
louthy committed Oct 25, 2024
1 parent c0457b7 commit a56fd84
Showing 1 changed file with 21 additions and 75 deletions.
96 changes: 21 additions & 75 deletions language-ext/LanguageExt.Core/Effects/IO/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,14 @@
<li><a href="#EnvIO_0_Token_0" class="link"><div class="nowrap">Token</div></a></li>
<li><a href="#EnvIO_0_Source_0" class="link"><div class="nowrap">Source</div></a></li>
<li><a href="#EnvIO_0_SyncContext_0" class="link"><div class="nowrap">SyncContext</div></a></li>
<li><a href="#EnvIO_0_FromToken_0" class="link"><div class="nowrap">FromToken

<span class='parens'>(</span>CancellationToken token<span class='parens'>)</span></div></a></li>
<li><a href="#EnvIO_0_FromToken_0" class="link"><div class="nowrap">FromToken

<span class='parens'>(</span>Resources resources<span class='comma'>, </span>CancellationToken token<span class='parens'>)</span></div></a></li>
<li><a href="#EnvIO_0_New_0" class="link"><div class="nowrap">New

<span class='parens'>(</span>
Resources? resources = null,
CancellationToken token = default,
CancellationTokenSource? source = null,
SynchronizationContext? syncContext = null<span class='parens'>)</span></div></a></li>
<li><a href="#EnvIO_0_Local_0" class="link"><div class="nowrap">Local</div></a></li>
<li><a href="#EnvIO_0_LocalResources_0" class="link"><div class="nowrap">LocalResources</div></a></li>
<li><a href="#EnvIO_0_LocalCancel_0" class="link"><div class="nowrap">LocalCancel</div></a></li>
<li><a href="#EnvIO_0_LocalSyncContext_0" class="link"><div class="nowrap">LocalSyncContext</div></a></li>
Expand Down Expand Up @@ -1200,9 +1195,9 @@
<div class="subs methods"><p class="caption">Properties</p>
<div class="top"><p class="src"><span class="keyword">property</span>
EnvIO
<a id="EnvIO_0_LocalResources_0" class="def">LocalResources</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L94" class="link">Source</a>
<a href="#EnvIO_0_LocalResources_0" class="selflink">#</a>
<a id="EnvIO_0_Local_0" class="def">Local</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L68" class="link">Source</a>
<a href="#EnvIO_0_Local_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>
Expand All @@ -1223,9 +1218,9 @@
</div>
<div class="top"><p class="src"><span class="keyword">property</span>
EnvIO
<a id="EnvIO_0_LocalCancel_0" class="def">LocalCancel</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L97" class="link">Source</a>
<a href="#EnvIO_0_LocalCancel_0" class="selflink">#</a>
<a id="EnvIO_0_LocalResources_0" class="def">LocalResources</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L71" class="link">Source</a>
<a href="#EnvIO_0_LocalResources_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>
Expand All @@ -1246,9 +1241,9 @@
</div>
<div class="top"><p class="src"><span class="keyword">property</span>
EnvIO
<a id="EnvIO_0_LocalSyncContext_0" class="def">LocalSyncContext</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L100" class="link">Source</a>
<a href="#EnvIO_0_LocalSyncContext_0" class="selflink">#</a>
<a id="EnvIO_0_LocalCancel_0" class="def">LocalCancel</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L74" class="link">Source</a>
<a href="#EnvIO_0_LocalCancel_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
<div></div>
Expand All @@ -1266,68 +1261,18 @@



</div></div>

<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
</div>
<div class="top"><p class="src"><span class="keyword">property</span>
EnvIO
<a id="EnvIO_0_FromToken_0" class="def">FromToken</a>

<span class='parens'>(</span>CancellationToken token<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L40" class="link">Source</a>
<a href="#EnvIO_0_FromToken_0" class="selflink">#</a>
<a id="EnvIO_0_LocalSyncContext_0" class="def">LocalSyncContext</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L77" class="link">Source</a>
<a href="#EnvIO_0_LocalSyncContext_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Creates a new EnvIO and registers it with the <code>token</code> provided, so if the <code>token</code> gets
a cancellation signal then so will any computation that uses the <code>EnvIO</code>.</p>
</div>
<div class="doc"><div></div>
<div></div>
<div class="methods"><p class="caption">Parameters</p>
<div class="params-and-returns"><table><tbody><tr><td class="src clearfix"><span class="keyword">param</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">token</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Token to register with</p>
</span></td></tr>
<tr><td class="src clearfix"><span class="keyword">returns</span></td>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>Constructed EnvIO</p>
</span></td></tr></tbody></table></div></div>
</div>












</div>
<div class="top"><p class="src"><span class="keyword">method</span>
EnvIO
<a id="EnvIO_0_FromToken_0" class="def">FromToken</a>

<span class='parens'>(</span>Resources resources<span class='comma'>, </span>CancellationToken token<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L59" class="link">Source</a>
<a href="#EnvIO_0_FromToken_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div><p>Creates a new EnvIO and registers it with the <code>token</code> provided, so if the <code>token</code> gets
a cancellation signal then so will any computation that uses the <code>EnvIO</code>.</p>
</div>
<div></div>
<div class="methods"><p class="caption">Parameters</p>
<div class="params-and-returns"><table><tbody><tr><td class="src clearfix"><span class="keyword">param</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">resources</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Resources collection to use instead of letting EnvIO construct one</p>
</span></td></tr>
<tr><td class="src clearfix"><span class="keyword">param</span></td>
<td class="src clearfix"><span class="inst-left"><span class="def">token</span></span></td>
<td class="src clearfix"><span class="instruction inst-left"><p>Token to register with</p>
</span></td></tr>
<tr><td class="src clearfix"><span class="keyword">returns</span></td>
<td colspan="2" class="src clearfix"><span class="instruction inst-left"><p>Constructed EnvIO</p>
</span></td></tr></tbody></table></div></div>
</div>



Expand All @@ -1339,8 +1284,9 @@



</div></div>

</div>
<div class="subs methods"><p class="caption">Methods</p>
<div class="top"><p class="src"><span class="keyword">method</span>
EnvIO
<a id="EnvIO_0_New_0" class="def">New</a>
Expand All @@ -1350,7 +1296,7 @@
CancellationToken token = default,
CancellationTokenSource? source = null,
SynchronizationContext? syncContext = null<span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L70" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L34" class="link">Source</a>
<a href="#EnvIO_0_New_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1375,7 +1321,7 @@
<a id="EnvIO_0_Dispose_0" class="def">Dispose</a>

<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L103" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L80" class="link">Source</a>
<a href="#EnvIO_0_Dispose_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand All @@ -1400,7 +1346,7 @@
<a id="EnvIO_0_ToString_0" class="def">ToString</a>

<span class='parens'>(</span><span class='parens'>)</span>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L113" class="link">Source</a>
<a href="https://github.com/louthy/language-ext/tree/main/LanguageExt.Core/Effects/IO/EnvIO.cs#L90" class="link">Source</a>
<a href="#EnvIO_0_ToString_0" class="selflink">#</a>
<div class="constraints"></div></p>
<div class="doc"><div></div>
Expand Down

0 comments on commit a56fd84

Please sign in to comment.