Generate API docs as markdown

This commit is contained in:
Jordan Wages 2026-07-07 01:56:58 -05:00
commit 85e90f7bd5
120 changed files with 14227 additions and 76482 deletions

View file

@ -2,11 +2,11 @@
<html>
<head>
<meta charset="utf-8">
<title>Class Password | CapyKit Documentation </title>
<title> Class Password | CapyKit Documentation </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class Password | CapyKit Documentation ">
<meta name="title" content=" Class Password | CapyKit Documentation ">
<meta name="description" content="Represents a password with its hash, salt and algorithm used for encryption.">
<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,416 +70,109 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="CapyKit.Password">
<h1 id="CapyKit_Password" data-uid="CapyKit.Password" class="text-break">
Class Password
</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>Represents a password with its hash, salt and algorithm used for encryption.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class Password</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">Password</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-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>
</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&lt;T&gt;(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="constructors">Constructors
</h2>
<a id="CapyKit_Password__ctor_" data-uid="CapyKit.Password.#ctor*"></a>
<h3 id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___" data-uid="CapyKit.Password.#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])">
Password(string, byte[], IPasswordAlgorithm, params object[])
</h3>
<div class="markdown level1 summary"><p>Constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The password to be hashed.</p>
</dd>
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd><p>The salt used for encryption.</p>
</dd>
<dt><code>algorithm</code> <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
<dd><p>The algorithm used for password encryption.</p>
</dd>
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
<dd><p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="CapyKit_Password_Algorithm_" data-uid="CapyKit.Password.Algorithm*"></a>
<h3 id="CapyKit_Password_Algorithm" data-uid="CapyKit.Password.Algorithm">
Algorithm
</h3>
<div class="markdown level1 summary"><p>Gets or sets the algorithm used for password encryption.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IPasswordAlgorithm Algorithm { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
<dd></dd>
</dl>
<a id="CapyKit_Password_Hash_" data-uid="CapyKit.Password.Hash*"></a>
<h3 id="CapyKit_Password_Hash" data-uid="CapyKit.Password.Hash">
Hash
</h3>
<div class="markdown level1 summary"><p>Gets or sets the hash of the password.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte[] Hash { 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.byte">byte</a>[]</dt>
<dd></dd>
</dl>
<a id="CapyKit_Password_Pbkdf2Algorithm_" data-uid="CapyKit.Password.Pbkdf2Algorithm*"></a>
<h3 id="CapyKit_Password_Pbkdf2Algorithm" data-uid="CapyKit.Password.Pbkdf2Algorithm">
Pbkdf2Algorithm
</h3>
<div class="markdown level1 summary"><p>Gets the preconfigured PBKDF2 algorithm.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></dt>
<dd><p>The preconfigured PBKDF2 algorithm.</p>
</dd>
</dl>
<a id="CapyKit_Password_Salt_" data-uid="CapyKit.Password.Salt*"></a>
<h3 id="CapyKit_Password_Salt" data-uid="CapyKit.Password.Salt">
Salt
</h3>
<div class="markdown level1 summary"><p>Gets or sets the salt used for encryption.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public byte[] Salt { 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.byte">byte</a>[]</dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="CapyKit_Password_Equals_" data-uid="CapyKit.Password.Equals*"></a>
<h3 id="CapyKit_Password_Equals_System_Object_" data-uid="CapyKit.Password.Equals(System.Object)">
Equals(object?)
</h3>
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object? obj)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The object to compare with the current object.</p>
</dd>
</dl>
<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 specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="CapyKit_Password_ToString_" data-uid="CapyKit.Password.ToString*"></a>
<h3 id="CapyKit_Password_ToString" data-uid="CapyKit.Password.ToString">
ToString()
</h3>
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</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.</p>
</dd>
</dl>
<h2 class="section" id="operators">Operators
</h2>
<a id="CapyKit_Password_op_Equality_" data-uid="CapyKit.Password.op_Equality*"></a>
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_" data-uid="CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)">
operator ==(Password, Password)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator ==(Password a, Password b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>a</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
<dd></dd>
</dl>
<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></dd>
</dl>
<a id="CapyKit_Password_op_Inequality_" data-uid="CapyKit.Password.op_Inequality*"></a>
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_" data-uid="CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)">
operator !=(Password, Password)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator !=(Password a, Password b)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>a</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
<dd></dd>
<dt><code>b</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
<dd></dd>
</dl>
<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></dd>
</dl>
<article data-uid="">
<h1 id="CapyKit_Password"> Class Password</h1>
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
Assembly: CapyKit.dll</p>
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
<pre><code class="lang-csharp">public class Password
</code></pre>
<h4 id="inheritance">Inheritance</h4>
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>
<a href="CapyKit.Password.html">Password</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__1___0___0_">ObjectExtensions.UpdateProperties&lt;Password&gt;(Password, Password)</a>,
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
<h2 id="constructors">Constructors</h2>
<h3 id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> Password(string, byte[], IPasswordAlgorithm, params object[])</h3>
<p>Constructor.</p>
<pre><code class="lang-csharp">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
</code></pre>
<h4 id="parameters">Parameters</h4>
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
<p>The password to be hashed.</p>
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
<p>The salt used for encryption.</p>
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
<p>The algorithm used for password encryption.</p>
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
<p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
<h2 id="properties">Properties</h2>
<h3 id="CapyKit_Password_Algorithm"> Algorithm</h3>
<p>Gets or sets the algorithm used for password encryption.</p>
<pre><code class="lang-csharp">public IPasswordAlgorithm Algorithm { get; }
</code></pre>
<h4 id="property-value">Property Value</h4>
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
<h3 id="CapyKit_Password_Hash"> Hash</h3>
<p>Gets or sets the hash of the password.</p>
<pre><code class="lang-csharp">public byte[] Hash { get; }
</code></pre>
<h4 id="property-value-1">Property Value</h4>
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
<h3 id="CapyKit_Password_Pbkdf2Algorithm"> Pbkdf2Algorithm</h3>
<p>Gets the preconfigured PBKDF2 algorithm.</p>
<pre><code class="lang-csharp">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
</code></pre>
<h4 id="property-value-2">Property Value</h4>
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
<h3 id="CapyKit_Password_Salt"> Salt</h3>
<p>Gets or sets the salt used for encryption.</p>
<pre><code class="lang-csharp">public byte[] Salt { get; }
</code></pre>
<h4 id="property-value-3">Property Value</h4>
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
<h2 id="methods">Methods</h2>
<h3 id="CapyKit_Password_Equals_System_Object_"> Equals(object?)</h3>
<p>Determines whether the specified object is equal to the current object.</p>
<pre><code class="lang-csharp">public override bool Equals(object? obj)
</code></pre>
<h4 id="parameters-1">Parameters</h4>
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>?</p>
<p>The object to compare with the current object.</p>
<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 specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
<h3 id="CapyKit_Password_ToString"> ToString()</h3>
<p>Returns a string that represents the current object.</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.</p>
<h2 id="operators">Operators</h2>
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_"> operator ==(Password, Password)</h3>
<pre><code class="lang-csharp">public static bool operator ==(Password a, Password b)
</code></pre>
<h4 id="parameters-2">Parameters</h4>
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
<h4 id="returns-2">Returns</h4>
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_"> operator !=(Password, Password)</h3>
<pre><code class="lang-csharp">public static bool operator !=(Password a, Password b)
</code></pre>
<h4 id="parameters-3">Parameters</h4>
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
<h4 id="returns-3">Returns</h4>
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
</article>
<div class="contribution d-print-none">
</div>
<div class="next-article d-print-none border-top" id="nextArticle"></div>
</div>