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 EnumerationExtensions | CapyKit Documentation </title>
|
||||
<title> Class EnumerationExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EnumerationExtensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EnumerationExtensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Provides static extentions methods for providing additional functionality for types.">
|
||||
<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,336 +70,107 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions.EnumerationExtensions">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Extensions_EnumerationExtensions" data-uid="CapyKit.Extensions.EnumerationExtensions" class="text-break">
|
||||
Class EnumerationExtensions
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Provides static extentions methods for providing additional functionality for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> types.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class EnumerationExtensions</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<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">EnumerationExtensions</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.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetDescription_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)">
|
||||
GetDescription(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a description.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetDescription(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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>The description if available, otherwise the string representation of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetName_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)">
|
||||
GetName(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetName(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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>The name of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetPrettyName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)">
|
||||
GetPrettyName(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a human readable name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetPrettyName(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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>The human readable name of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetValue_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetValue*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)">
|
||||
GetValue(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets an integer value representing the enumation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int GetValue(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The integer value of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_Parse_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)">
|
||||
Parse<T>(T, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Parse<T>(this T enumeration, string value) where T : Enum</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A T.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_Parse_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)">
|
||||
Parse<T>(T, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string value of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a>.</p>
|
||||
</dd>
|
||||
<dt><code>ignoreCase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True to ignore case.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A T.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions_EnumerationExtensions"> Class EnumerationExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||
<pre><code class="lang-csharp">public static class EnumerationExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</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.memberwiseclone">object.MemberwiseClone()</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_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_"> GetDescription(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a description.</p>
|
||||
<pre><code class="lang-csharp">public static string GetDescription(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The description if available, otherwise the string representation of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_"> GetName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"> GetPrettyName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a human readable name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetPrettyName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The human readable name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"> GetValue(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets an integer value representing the enumation.</p>
|
||||
<pre><code class="lang-csharp">public static int GetValue(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The integer value of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_"> Parse<T>(T, string)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The value.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"> Parse<T>(T, string, bool)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string value of the <span class="xref">System.Enum</span>.</p>
|
||||
<p><code>ignoreCase</code> <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True to ignore case.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</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