Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class PoolItem<T> | CapyKit Documentation </title>
|
||||
<title> Class PoolItem<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PoolItem<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class PoolItem<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A pool item. This class cannot be inherited.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,327 +70,86 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.PoolItem`1">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_PoolItem_1" data-uid="CapyKit.PoolItem`1" class="text-break">
|
||||
Class PoolItem<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A pool item. This class cannot be inherited.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class PoolItem<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of the pooled item.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">PoolItem<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Index_" data-uid="CapyKit.PoolItem`1.Index*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Index" data-uid="CapyKit.PoolItem`1.Index">
|
||||
Index
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the zero-based index of the pooled item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int Index { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The index.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Item_" data-uid="CapyKit.PoolItem`1.Item*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Item" data-uid="CapyKit.PoolItem`1.Item">
|
||||
Item
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the pooled resource.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public T Item { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The pooled resource.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Locked_" data-uid="CapyKit.PoolItem`1.Locked*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Locked" data-uid="CapyKit.PoolItem`1.Locked">
|
||||
Locked
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a value indicating whether this object is locked or not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Locked { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>A value indicating whether this object is locked or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_TypeName_" data-uid="CapyKit.PoolItem`1.TypeName*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_TypeName" data-uid="CapyKit.PoolItem`1.TypeName">
|
||||
TypeName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a> of the pooled item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string TypeName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a> of the pooled item.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_ReleaseLock_" data-uid="CapyKit.PoolItem`1.ReleaseLock*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_ReleaseLock" data-uid="CapyKit.PoolItem`1.ReleaseLock">
|
||||
ReleaseLock()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Releases the lock on the item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void ReleaseLock()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_PoolItem_1_ReleaseLock_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If the item is not locked, an error event is emitted.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_SetLock_" data-uid="CapyKit.PoolItem`1.SetLock*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_SetLock" data-uid="CapyKit.PoolItem`1.SetLock">
|
||||
SetLock()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the lock on the item indicating that it is in use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool SetLock()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is locked successfully, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_PoolItem_1"> Class PoolItem<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<pre><code class="lang-csharp">public sealed class PoolItem<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the pooled item.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<PoolItem<T>>(PoolItem<T>, PoolItem<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_Index"> Index</h3>
|
||||
<p>Gets the zero-based index of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public int Index { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_Item"> Item</h3>
|
||||
<p>Gets the pooled resource.</p>
|
||||
<pre><code class="lang-csharp">public T Item { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p>T</p>
|
||||
<h3 id="CapyKit_PoolItem_1_Locked"> Locked</h3>
|
||||
<p>Gets a value indicating whether this object is locked or not.</p>
|
||||
<pre><code class="lang-csharp">public bool Locked { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_TypeName"> TypeName</h3>
|
||||
<p>Gets the name of the <span class="xref">System.Type</span> of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public string TypeName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-3">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_ReleaseLock"> ReleaseLock()</h3>
|
||||
<p>Releases the lock on the item.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseLock()
|
||||
</code></pre>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>If the item is not locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_SetLock"> SetLock()</h3>
|
||||
<p>Sets the lock on the item indicating that it is in use.</p>
|
||||
<pre><code class="lang-csharp">public bool SetLock()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is locked successfully, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it
|
||||
fails.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_PoolItem_1_SetLock_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If the item is already locked, an error event is emitted.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_ToString_" data-uid="CapyKit.PoolItem`1.ToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_ToString" data-uid="CapyKit.PoolItem`1.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object and its lock state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object and its lock state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>If the item is already locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_ToString"> ToString()</h3>
|
||||
<p>Returns a string that represents the current object and its lock state.</p>
|
||||
<pre><code class="lang-csharp">public override string ToString()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string that represents the current object and its lock state.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue