Skip to content

Commit

Permalink
Update documentation from PR
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Oct 9, 2023
1 parent ef803e1 commit a77cc21
Show file tree
Hide file tree
Showing 188 changed files with 54,846 additions and 304 deletions.
74 changes: 74 additions & 0 deletions api/System.Collections.ArrayList.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -951,6 +951,80 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>


<a id="System_Collections_ArrayList_get_Item_" data-uid="System.Collections.ArrayList.get_Item*"></a>
<h4 id="System_Collections_ArrayList_get_Item_System_Int32_" data-uid="System.Collections.ArrayList.get_Item(System.Int32)">get_Item(int)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual object get_Item(int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Int32.html">int</a></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Object.html">object</a></td>
<td></td>
</tr>
</tbody>
</table>


<a id="System_Collections_ArrayList_set_Item_" data-uid="System.Collections.ArrayList.set_Item*"></a>
<h4 id="System_Collections_ArrayList_set_Item_System_Int32_System_Object_" data-uid="System.Collections.ArrayList.set_Item(System.Int32,System.Object)">set_Item(int, object)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void set_Item(int index, object value)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Int32.html">int</a></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="System.Object.html">object</a></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="System.Collections.IList.html">IList</a>
Expand Down
54 changes: 50 additions & 4 deletions api/System.Device.Adc.AdcChannelBase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,15 @@

<h1 id="System_Device_Adc_AdcChannelBase" data-uid="System.Device.Adc.AdcChannelBase" class="text-break">Class AdcChannelBase
</h1>
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a>.</p>
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="System.Object.html">object</a></div>
<div class="level1"><span class="xref">AdcChannelBase</span></div>
<div class="level2"><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></div>
<div class="level2"><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
Expand All @@ -126,7 +127,7 @@ <h5>Inherited Members</h5>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="System.html">System</a>.<a class="xref" href="System.Device.html">Device</a>.<a class="xref" href="System.Device.Adc.html">Adc</a></h6>
<h6><strong>Assembly</strong>: System.Device.Adc.dll</h6>
<h6><strong>Assembly</strong>: nanoFramework.GiantGecko.Adc.dll</h6>
<h5 id="System_Device_Adc_AdcChannelBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class AdcChannelBase</code></pre>
Expand Down Expand Up @@ -166,8 +167,8 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></td>
<td><p>The <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a></td>
<td><p>The <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -228,6 +229,51 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>


<a id="System_Device_Adc_AdcChannelBase_ReadValueAveraged_" data-uid="System.Device.Adc.AdcChannelBase.ReadValueAveraged*"></a>
<h4 id="System_Device_Adc_AdcChannelBase_ReadValueAveraged_System_Int32_" data-uid="System.Device.Adc.AdcChannelBase.ReadValueAveraged(System.Int32)">ReadValueAveraged(int)</h4>
<div class="markdown level1 summary"><p>Reads the averaged digital representation of <code class="paramref">count</code> analog values read from the ADC.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract int ReadValueAveraged(int count)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Int32.html">int</a></td>
<td><span class="parametername">count</span></td>
<td><p>Number of samples to take for averaging.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Int32.html">int</a></td>
<td><p>The digital value with the averaged value of <code class="paramref">count</code> samples.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="nanoFramework.Logging.LogDispatcher.html#nanoFramework_Logging_LogDispatcher_GetCurrentClassLogger_System_Object_">LogDispatcher.GetCurrentClassLogger(object)</a>
Expand Down
87 changes: 83 additions & 4 deletions api/System.Device.Adc.AdcControllerBase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,15 @@

<h1 id="System_Device_Adc_AdcControllerBase" data-uid="System.Device.Adc.AdcControllerBase" class="text-break">Class AdcControllerBase
</h1>
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="System.Object.html">object</a></div>
<div class="level1"><span class="xref">AdcControllerBase</span></div>
<div class="level2"><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></div>
<div class="level2"><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
Expand All @@ -126,7 +127,7 @@ <h5>Inherited Members</h5>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="System.html">System</a>.<a class="xref" href="System.Device.html">Device</a>.<a class="xref" href="System.Device.Adc.html">Adc</a></h6>
<h6><strong>Assembly</strong>: System.Device.Adc.dll</h6>
<h6><strong>Assembly</strong>: nanoFramework.GiantGecko.Adc.dll</h6>
<h5 id="System_Device_Adc_AdcControllerBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class AdcControllerBase</code></pre>
Expand All @@ -149,7 +150,7 @@ <h3 id="properties">Properties

<a id="System_Device_Adc_AdcControllerBase_ChannelCount_" data-uid="System.Device.Adc.AdcControllerBase.ChannelCount*"></a>
<h4 id="System_Device_Adc_AdcControllerBase_ChannelCount" data-uid="System.Device.Adc.AdcControllerBase.ChannelCount">ChannelCount</h4>
<div class="markdown level1 summary"><p>The number of channels available on the <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
<div class="markdown level1 summary"><p>The number of channels available on the <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand Down Expand Up @@ -280,6 +281,33 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>


<a id="System_Device_Adc_AdcControllerBase_SupportedResolutionsInBits_" data-uid="System.Device.Adc.AdcControllerBase.SupportedResolutionsInBits*"></a>
<h4 id="System_Device_Adc_AdcControllerBase_SupportedResolutionsInBits" data-uid="System.Device.Adc.AdcControllerBase.SupportedResolutionsInBits">SupportedResolutionsInBits</h4>
<div class="markdown level1 summary"><p>Gets the resolution(s) of the controller as number of bits it has. For example, if we have a 10-bit ADC, that means it can detect 1024 (2^10) discrete levels.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract SampleResolution[] SupportedResolutionsInBits { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.SampleResolution.html">SampleResolution</a>[]</td>
<td><p>Array with the resolution(s) that the ADC has support for.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>

Expand Down Expand Up @@ -366,7 +394,58 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></td>
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></td>
<td><p>The ADC channel.</p>
</td>
</tr>
</tbody>
</table>


<a id="System_Device_Adc_AdcControllerBase_OpenChannel_" data-uid="System.Device.Adc.AdcControllerBase.OpenChannel*"></a>
<h4 id="System_Device_Adc_AdcControllerBase_OpenChannel_System_Int32_nanoFramework_GiantGecko_Adc_AdcChannelConfiguration_" data-uid="System.Device.Adc.AdcControllerBase.OpenChannel(System.Int32,nanoFramework.GiantGecko.Adc.AdcChannelConfiguration)">OpenChannel(int, AdcChannelConfiguration)</h4>
<div class="markdown level1 summary"><p>Opens a connection to the specified ADC channel with the specified configurations.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract AdcChannel OpenChannel(int channelNumber, AdcChannelConfiguration configuration)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="System.Int32.html">int</a></td>
<td><span class="parametername">channelNumber</span></td>
<td><p>The channel to connect to.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannelConfiguration.html">AdcChannelConfiguration</a></td>
<td><span class="parametername">configuration</span></td>
<td><p>Initial configuration for ADC channel.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></td>
<td><p>The ADC channel.</p>
</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions api/System.Device.Adc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,13 @@ <h4><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></h4>
<section><p>Represents a single ADC channel.</p>
</section>
<h4><a class="xref" href="System.Device.Adc.AdcChannelBase.html">AdcChannelBase</a></h4>
<section><p>Base class for <a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a>.</p>
<section><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a>.</p>
</section>
<h4><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></h4>
<section><p>Represents an <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a> on the system</p>
</section>
<h4><a class="xref" href="System.Device.Adc.AdcControllerBase.html">AdcControllerBase</a></h4>
<section><p>Base class for <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
<section><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
</section>
<h3 id="enums">
Enums
Expand Down
Loading

0 comments on commit a77cc21

Please sign in to comment.