Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -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,99 +70,53 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit"> Namespace CapyKit</h1>
|
||||
|
||||
<h1 id="CapyKit" data-uid="CapyKit" class="text-break">Namespace CapyKit</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></dt>
|
||||
<dd><p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
<h3 id="namespaces">Namespaces</h3>
|
||||
<p><a href="CapyKit.Attributes.html">CapyKit.Attributes</a></p>
|
||||
<p><a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a></p>
|
||||
<p><a href="CapyKit.Extensions.html">CapyKit.Extensions</a></p>
|
||||
<p><a href="CapyKit.Helpers.html">CapyKit.Helpers</a></p>
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></dt>
|
||||
<dd><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Color.html">Color</a></dt>
|
||||
<dd><p>An object representing a color.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></dt>
|
||||
<dd><p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.PoolItem-1.html">PoolItem<T></a></dt>
|
||||
<dd><p>A pool item. This class cannot be inherited.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Pool-1.html">Pool<T></a></dt>
|
||||
<dd><p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
<p><a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
<p><a href="CapyKit.Color.html">Color</a></p>
|
||||
<p>An object representing a color.</p>
|
||||
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
<p><a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
objects of type <code class="typeparamref">T</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></dt>
|
||||
<dd><p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="interfaces">
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
||||
<dd><p>Defines the contract for password encryption algorithms.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>Enumeration representing different event level severity values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.NamedColor.html">NamedColor</a></dt>
|
||||
<dd><p>Enum representing a set of named colors with their corresponding HEX values. These colors are
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<p><a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>Enumeration representing different event level severity values.</p>
|
||||
<p><a href="CapyKit.NamedColor.html">NamedColor</a></p>
|
||||
<p>Enum representing a set of named colors with their corresponding HEX values. These colors are
|
||||
inspired by the XKCD color palette (<a href="https://xkcd.com/color/rgb/" target="_blank">Link</a>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="delegates">
|
||||
Delegates
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
|
||||
<dd><p>A delegate representing an event handler that accepts a <a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h3 id="delegates">Delegates</h3>
|
||||
<p><a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</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