Skip to content

Commit 4be1831

Browse files
migueldeicazamigueldeicaza
committed
Updated API docs
1 parent ba0fb1b commit 4be1831

17 files changed

Lines changed: 26022 additions & 2855 deletions

‎docs/TensorFlow/TFDisposable.html‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ <h2 class="Section">Public Constructors</h2>
247247
</b>()</div>
248248
</td>
249249
<td>
250-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
251-
</td>
250+
Initializes a new instance of the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> class.
251+
</td>
252252
</tr>
253253
<tr valign="top">
254254
<td>
@@ -262,8 +262,9 @@ <h2 class="Section">Public Constructors</h2>
262262
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IntPtr">IntPtr</a>)</div>
263263
</td>
264264
<td>
265-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
266-
</td>
265+
Initializes a new instance of the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> class
266+
from the handle that it will wrap.
267+
</td>
267268
</tr>
268269
</table>
269270
</div>
@@ -301,7 +302,9 @@ <h2 class="Section">Public Methods</h2>
301302
<td colspan="2">
302303
<b>
303304
<a href="#M:TensorFlow.TFDisposable.Dispose()">Dispose</a>
304-
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
305+
</b>()<blockquote>
306+
Releases all resource used by the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> object.
307+
</blockquote></td>
305308
</tr>
306309
<tr valign="top">
307310
<td>
@@ -311,7 +314,9 @@ <h2 class="Section">Public Methods</h2>
311314
<td colspan="2">
312315
<b>
313316
<a href="#M:TensorFlow.TFDisposable.Dispose(System.Boolean)">Dispose</a>
314-
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
317+
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a>)<blockquote>
318+
Dispose the specified object
319+
</blockquote></td>
315320
</tr>
316321
<tr valign="top">
317322
<td>
@@ -334,8 +339,8 @@ <h2 class="Section" id="MemberDetails">Member Details</h2>
334339
<h3 id="C:TensorFlow.TFDisposable()">TFDisposable Constructor</h3>
335340
<blockquote id="C:TensorFlow.TFDisposable():member">
336341
<div class="msummary">
337-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
338-
</div>
342+
Initializes a new instance of the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> class.
343+
</div>
339344
<h2>Syntax</h2>
340345
<div class="Signature">public <b>TFDisposable</b> ()</div>
341346
<h2 class="Section">Remarks</h2>
@@ -350,8 +355,9 @@ <h2 class="Section">Requirements</h2>
350355
<h3 id="C:TensorFlow.TFDisposable(System.IntPtr)">TFDisposable Constructor</h3>
351356
<blockquote id="C:TensorFlow.TFDisposable(System.IntPtr):member">
352357
<div class="msummary">
353-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
354-
</div>
358+
Initializes a new instance of the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> class
359+
from the handle that it will wrap.
360+
</div>
355361
<h2>Syntax</h2>
356362
<div class="Signature">public <b>TFDisposable</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.IntPtr">IntPtr</a> handle)</div>
357363
<h4 class="Subsection">Parameters</h4>
@@ -377,14 +383,15 @@ <h2 class="Section">Requirements</h2>
377383
<h3 id="M:TensorFlow.TFDisposable.Dispose()">Dispose Method</h3>
378384
<blockquote id="M:TensorFlow.TFDisposable.Dispose():member">
379385
<div class="msummary">
380-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
381-
</div>
386+
Releases all resource used by the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> object.
387+
</div>
382388
<h2>Syntax</h2>
383389
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Dispose</b> ()</div>
384390
<h2 class="Section">Remarks</h2>
385-
<div class="SectionBox" id="M:TensorFlow.TFDisposable.Dispose():Remarks">
386-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
387-
</div>
391+
<div class="SectionBox" id="M:TensorFlow.TFDisposable.Dispose():Remarks">Call Dispose when you are finished using the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a>. The
392+
Dispose method leaves the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> in an unusable state. After
393+
calling Dispose, you must release all references to the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> so
394+
the garbage collector can reclaim the memory that the <a href="../TensorFlow/TFDisposable.html">TensorFlow.TFDisposable</a> was occupying.</div>
388395
<h2 class="Section">Requirements</h2>
389396
<div class="SectionBox" id="M:TensorFlow.TFDisposable.Dispose():Version Information">
390397
<b>Namespace: </b>TensorFlow<br /><b>Assembly: </b>TensorFlowSharp (in TensorFlowSharp.dll)<br /><b>Assembly Versions: </b>1.0.0.0</div>
@@ -393,8 +400,8 @@ <h2 class="Section">Requirements</h2>
393400
<h3 id="M:TensorFlow.TFDisposable.Dispose(System.Boolean)">Dispose Method</h3>
394401
<blockquote id="M:TensorFlow.TFDisposable.Dispose(System.Boolean):member">
395402
<div class="msummary">
396-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
397-
</div>
403+
Dispose the specified object
404+
</div>
398405
<h2>Syntax</h2>
399406
<div class="Signature">public virtual <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Dispose</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Boolean">bool</a> disposing)</div>
400407
<h4 class="Subsection">Parameters</h4>
@@ -403,9 +410,7 @@ <h4 class="Subsection">Parameters</h4>
403410
<dt>
404411
<i>disposing</i>
405412
</dt>
406-
<dd>
407-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
408-
</dd>
413+
<dd>If set to <tt>true</tt> it means that this method was called from Dispose, otherwise from the finalizer.</dd>
409414
</dl>
410415
</blockquote>
411416
<h2 class="Section">Remarks</h2>

0 commit comments

Comments
 (0)