Skip to content

Commit a77cc21

Browse files
author
[email protected]
committed
Update documentation from PR
1 parent ef803e1 commit a77cc21

File tree

188 files changed

+54846
-304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

188 files changed

+54846
-304
lines changed

‎api/System.Collections.ArrayList.html

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -951,6 +951,80 @@ <h5 class="returns">Returns</h5>
951951
</tr>
952952
</tbody>
953953
</table>
954+
955+
956+
<a id="System_Collections_ArrayList_get_Item_" data-uid="System.Collections.ArrayList.get_Item*"></a>
957+
<h4 id="System_Collections_ArrayList_get_Item_System_Int32_" data-uid="System.Collections.ArrayList.get_Item(System.Int32)">get_Item(int)</h4>
958+
<div class="markdown level1 summary"></div>
959+
<div class="markdown level1 conceptual"></div>
960+
<h5 class="declaration">Declaration</h5>
961+
<div class="codewrapper">
962+
<pre><code class="lang-csharp hljs">public virtual object get_Item(int index)</code></pre>
963+
</div>
964+
<h5 class="parameters">Parameters</h5>
965+
<table class="table table-bordered table-condensed">
966+
<thead>
967+
<tr>
968+
<th>Type</th>
969+
<th>Name</th>
970+
<th>Description</th>
971+
</tr>
972+
</thead>
973+
<tbody>
974+
<tr>
975+
<td><a class="xref" href="System.Int32.html">int</a></td>
976+
<td><span class="parametername">index</span></td>
977+
<td></td>
978+
</tr>
979+
</tbody>
980+
</table>
981+
<h5 class="returns">Returns</h5>
982+
<table class="table table-bordered table-condensed">
983+
<thead>
984+
<tr>
985+
<th>Type</th>
986+
<th>Description</th>
987+
</tr>
988+
</thead>
989+
<tbody>
990+
<tr>
991+
<td><a class="xref" href="System.Object.html">object</a></td>
992+
<td></td>
993+
</tr>
994+
</tbody>
995+
</table>
996+
997+
998+
<a id="System_Collections_ArrayList_set_Item_" data-uid="System.Collections.ArrayList.set_Item*"></a>
999+
<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>
1000+
<div class="markdown level1 summary"></div>
1001+
<div class="markdown level1 conceptual"></div>
1002+
<h5 class="declaration">Declaration</h5>
1003+
<div class="codewrapper">
1004+
<pre><code class="lang-csharp hljs">public virtual void set_Item(int index, object value)</code></pre>
1005+
</div>
1006+
<h5 class="parameters">Parameters</h5>
1007+
<table class="table table-bordered table-condensed">
1008+
<thead>
1009+
<tr>
1010+
<th>Type</th>
1011+
<th>Name</th>
1012+
<th>Description</th>
1013+
</tr>
1014+
</thead>
1015+
<tbody>
1016+
<tr>
1017+
<td><a class="xref" href="System.Int32.html">int</a></td>
1018+
<td><span class="parametername">index</span></td>
1019+
<td></td>
1020+
</tr>
1021+
<tr>
1022+
<td><a class="xref" href="System.Object.html">object</a></td>
1023+
<td><span class="parametername">value</span></td>
1024+
<td></td>
1025+
</tr>
1026+
</tbody>
1027+
</table>
9541028
<h3 id="implements">Implements</h3>
9551029
<div>
9561030
<a class="xref" href="System.Collections.IList.html">IList</a>

‎api/System.Device.Adc.AdcChannelBase.html

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,15 @@
9292

9393
<h1 id="System_Device_Adc_AdcChannelBase" data-uid="System.Device.Adc.AdcChannelBase" class="text-break">Class AdcChannelBase
9494
</h1>
95-
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a>.</p>
95+
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a>.</p>
9696
</div>
9797
<div class="markdown level0 conceptual"></div>
9898
<div class="inheritance">
9999
<h5>Inheritance</h5>
100100
<div class="level0"><a class="xref" href="System.Object.html">object</a></div>
101101
<div class="level1"><span class="xref">AdcChannelBase</span></div>
102102
<div class="level2"><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></div>
103+
<div class="level2"><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></div>
103104
</div>
104105
<div class="inheritedMembers">
105106
<h5>Inherited Members</h5>
@@ -126,7 +127,7 @@ <h5>Inherited Members</h5>
126127
</div>
127128
</div>
128129
<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>
129-
<h6><strong>Assembly</strong>: System.Device.Adc.dll</h6>
130+
<h6><strong>Assembly</strong>: nanoFramework.GiantGecko.Adc.dll</h6>
130131
<h5 id="System_Device_Adc_AdcChannelBase_syntax">Syntax</h5>
131132
<div class="codewrapper">
132133
<pre><code class="lang-csharp hljs">public abstract class AdcChannelBase</code></pre>
@@ -166,8 +167,8 @@ <h5 class="propertyValue">Property Value</h5>
166167
</thead>
167168
<tbody>
168169
<tr>
169-
<td><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></td>
170-
<td><p>The <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
170+
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a></td>
171+
<td><p>The <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
171172
</td>
172173
</tr>
173174
</tbody>
@@ -228,6 +229,51 @@ <h5 class="returns">Returns</h5>
228229
</tr>
229230
</tbody>
230231
</table>
232+
233+
234+
<a id="System_Device_Adc_AdcChannelBase_ReadValueAveraged_" data-uid="System.Device.Adc.AdcChannelBase.ReadValueAveraged*"></a>
235+
<h4 id="System_Device_Adc_AdcChannelBase_ReadValueAveraged_System_Int32_" data-uid="System.Device.Adc.AdcChannelBase.ReadValueAveraged(System.Int32)">ReadValueAveraged(int)</h4>
236+
<div class="markdown level1 summary"><p>Reads the averaged digital representation of <code class="paramref">count</code> analog values read from the ADC.</p>
237+
</div>
238+
<div class="markdown level1 conceptual"></div>
239+
<h5 class="declaration">Declaration</h5>
240+
<div class="codewrapper">
241+
<pre><code class="lang-csharp hljs">public abstract int ReadValueAveraged(int count)</code></pre>
242+
</div>
243+
<h5 class="parameters">Parameters</h5>
244+
<table class="table table-bordered table-condensed">
245+
<thead>
246+
<tr>
247+
<th>Type</th>
248+
<th>Name</th>
249+
<th>Description</th>
250+
</tr>
251+
</thead>
252+
<tbody>
253+
<tr>
254+
<td><a class="xref" href="System.Int32.html">int</a></td>
255+
<td><span class="parametername">count</span></td>
256+
<td><p>Number of samples to take for averaging.</p>
257+
</td>
258+
</tr>
259+
</tbody>
260+
</table>
261+
<h5 class="returns">Returns</h5>
262+
<table class="table table-bordered table-condensed">
263+
<thead>
264+
<tr>
265+
<th>Type</th>
266+
<th>Description</th>
267+
</tr>
268+
</thead>
269+
<tbody>
270+
<tr>
271+
<td><a class="xref" href="System.Int32.html">int</a></td>
272+
<td><p>The digital value with the averaged value of <code class="paramref">count</code> samples.</p>
273+
</td>
274+
</tr>
275+
</tbody>
276+
</table>
231277
<h3 id="extensionmethods">Extension Methods</h3>
232278
<div>
233279
<a class="xref" href="nanoFramework.Logging.LogDispatcher.html#nanoFramework_Logging_LogDispatcher_GetCurrentClassLogger_System_Object_">LogDispatcher.GetCurrentClassLogger(object)</a>

‎api/System.Device.Adc.AdcControllerBase.html

Lines changed: 83 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,15 @@
9292

9393
<h1 id="System_Device_Adc_AdcControllerBase" data-uid="System.Device.Adc.AdcControllerBase" class="text-break">Class AdcControllerBase
9494
</h1>
95-
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
95+
<div class="markdown level0 summary"><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
9696
</div>
9797
<div class="markdown level0 conceptual"></div>
9898
<div class="inheritance">
9999
<h5>Inheritance</h5>
100100
<div class="level0"><a class="xref" href="System.Object.html">object</a></div>
101101
<div class="level1"><span class="xref">AdcControllerBase</span></div>
102102
<div class="level2"><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></div>
103+
<div class="level2"><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a></div>
103104
</div>
104105
<div class="inheritedMembers">
105106
<h5>Inherited Members</h5>
@@ -126,7 +127,7 @@ <h5>Inherited Members</h5>
126127
</div>
127128
</div>
128129
<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>
129-
<h6><strong>Assembly</strong>: System.Device.Adc.dll</h6>
130+
<h6><strong>Assembly</strong>: nanoFramework.GiantGecko.Adc.dll</h6>
130131
<h5 id="System_Device_Adc_AdcControllerBase_syntax">Syntax</h5>
131132
<div class="codewrapper">
132133
<pre><code class="lang-csharp hljs">public abstract class AdcControllerBase</code></pre>
@@ -149,7 +150,7 @@ <h3 id="properties">Properties
149150

150151
<a id="System_Device_Adc_AdcControllerBase_ChannelCount_" data-uid="System.Device.Adc.AdcControllerBase.ChannelCount*"></a>
151152
<h4 id="System_Device_Adc_AdcControllerBase_ChannelCount" data-uid="System.Device.Adc.AdcControllerBase.ChannelCount">ChannelCount</h4>
152-
<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>
153+
<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>
153154
</div>
154155
<div class="markdown level1 conceptual"></div>
155156
<h5 class="declaration">Declaration</h5>
@@ -280,6 +281,33 @@ <h5 class="propertyValue">Property Value</h5>
280281
</tr>
281282
</tbody>
282283
</table>
284+
285+
286+
<a id="System_Device_Adc_AdcControllerBase_SupportedResolutionsInBits_" data-uid="System.Device.Adc.AdcControllerBase.SupportedResolutionsInBits*"></a>
287+
<h4 id="System_Device_Adc_AdcControllerBase_SupportedResolutionsInBits" data-uid="System.Device.Adc.AdcControllerBase.SupportedResolutionsInBits">SupportedResolutionsInBits</h4>
288+
<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>
289+
</div>
290+
<div class="markdown level1 conceptual"></div>
291+
<h5 class="declaration">Declaration</h5>
292+
<div class="codewrapper">
293+
<pre><code class="lang-csharp hljs">public abstract SampleResolution[] SupportedResolutionsInBits { get; }</code></pre>
294+
</div>
295+
<h5 class="propertyValue">Property Value</h5>
296+
<table class="table table-bordered table-condensed">
297+
<thead>
298+
<tr>
299+
<th>Type</th>
300+
<th>Description</th>
301+
</tr>
302+
</thead>
303+
<tbody>
304+
<tr>
305+
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.SampleResolution.html">SampleResolution</a>[]</td>
306+
<td><p>Array with the resolution(s) that the ADC has support for.</p>
307+
</td>
308+
</tr>
309+
</tbody>
310+
</table>
283311
<h3 id="methods">Methods
284312
</h3>
285313

@@ -366,7 +394,58 @@ <h5 class="returns">Returns</h5>
366394
</thead>
367395
<tbody>
368396
<tr>
369-
<td><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></td>
397+
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></td>
398+
<td><p>The ADC channel.</p>
399+
</td>
400+
</tr>
401+
</tbody>
402+
</table>
403+
404+
405+
<a id="System_Device_Adc_AdcControllerBase_OpenChannel_" data-uid="System.Device.Adc.AdcControllerBase.OpenChannel*"></a>
406+
<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>
407+
<div class="markdown level1 summary"><p>Opens a connection to the specified ADC channel with the specified configurations.</p>
408+
</div>
409+
<div class="markdown level1 conceptual"></div>
410+
<h5 class="declaration">Declaration</h5>
411+
<div class="codewrapper">
412+
<pre><code class="lang-csharp hljs">public abstract AdcChannel OpenChannel(int channelNumber, AdcChannelConfiguration configuration)</code></pre>
413+
</div>
414+
<h5 class="parameters">Parameters</h5>
415+
<table class="table table-bordered table-condensed">
416+
<thead>
417+
<tr>
418+
<th>Type</th>
419+
<th>Name</th>
420+
<th>Description</th>
421+
</tr>
422+
</thead>
423+
<tbody>
424+
<tr>
425+
<td><a class="xref" href="System.Int32.html">int</a></td>
426+
<td><span class="parametername">channelNumber</span></td>
427+
<td><p>The channel to connect to.</p>
428+
</td>
429+
</tr>
430+
<tr>
431+
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannelConfiguration.html">AdcChannelConfiguration</a></td>
432+
<td><span class="parametername">configuration</span></td>
433+
<td><p>Initial configuration for ADC channel.</p>
434+
</td>
435+
</tr>
436+
</tbody>
437+
</table>
438+
<h5 class="returns">Returns</h5>
439+
<table class="table table-bordered table-condensed">
440+
<thead>
441+
<tr>
442+
<th>Type</th>
443+
<th>Description</th>
444+
</tr>
445+
</thead>
446+
<tbody>
447+
<tr>
448+
<td><a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a></td>
370449
<td><p>The ADC channel.</p>
371450
</td>
372451
</tr>

‎api/System.Device.Adc.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@ <h4><a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a></h4>
100100
<section><p>Represents a single ADC channel.</p>
101101
</section>
102102
<h4><a class="xref" href="System.Device.Adc.AdcChannelBase.html">AdcChannelBase</a></h4>
103-
<section><p>Base class for <a class="xref" href="System.Device.Adc.AdcChannel.html">AdcChannel</a>.</p>
103+
<section><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcChannel.html">AdcChannel</a>.</p>
104104
</section>
105105
<h4><a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a></h4>
106106
<section><p>Represents an <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a> on the system</p>
107107
</section>
108108
<h4><a class="xref" href="System.Device.Adc.AdcControllerBase.html">AdcControllerBase</a></h4>
109-
<section><p>Base class for <a class="xref" href="System.Device.Adc.AdcController.html">AdcController</a>.</p>
109+
<section><p>Base class for <a class="xref" href="nanoFramework.GiantGecko.Adc.AdcController.html">AdcController</a>.</p>
110110
</section>
111111
<h3 id="enums">
112112
Enums

0 commit comments

Comments
 (0)