Migrating to docfx

This commit is contained in:
Jordan Wages 2026-07-01 23:01:00 -05:00
commit bc4c63a7cd
646 changed files with 86228 additions and 27821 deletions

579
Docs/_site/manifest.json Normal file
View file

@ -0,0 +1,579 @@
{
"source_base_path": "/home/jordanwages/Git/CapyKit/Docs",
"xrefmap": "xrefmap.yml",
"files": [
{
"type": "Resource",
"output": {
"resource": {
"relative_path": "index.json"
}
}
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Attributes.EnumerationAttribute<T>",
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.EnumerationAttribute-1.yml\" sourcestartlinenumber=\"1\">Custom attribute class for decorating enumeration fields with additional data.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Attributes.EnumerationDescriptionAttribute",
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.EnumerationDescriptionAttribute.yml\" sourcestartlinenumber=\"1\">An attribute class for decorating enumeration fields with a description.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Attributes.ValueFormatAttribute",
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.ValueFormatAttribute.yml\" sourcestartlinenumber=\"1\">Custom attribute for formatting values in a specific way.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Attributes.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Attributes.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Attributes",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.CapyEventArgs.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.CapyEventArgs.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.CapyEventArgs",
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventArgs.yml\" sourcestartlinenumber=\"1\">The CapyEventArgs class represents an event argument instance with event level, message, and\nmethod name information.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.CapyEventHandler.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.CapyEventHandler.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.CapyEventHandler",
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventHandler.yml\" sourcestartlinenumber=\"1\">A delegate representing an event handler that accepts a <xref href=\"CapyKit.CapyEventArgs\" data-throw-if-not-resolved=\"false\"></xref> instance.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.CapyEventReporter.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.CapyEventReporter.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.CapyEventReporter",
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventReporter.yml\" sourcestartlinenumber=\"1\">The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Color.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Color.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Color",
"Summary": "<p sourcefile=\"api/CapyKit.Color.yml\" sourcestartlinenumber=\"1\">An object representing a color.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.EncryptedValue-1.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.EncryptedValue-1.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.EncryptedValue<T>",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Enumerations.MeasurementSystem.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Enumerations.MeasurementSystem",
"Summary": "<p sourcefile=\"api/CapyKit.Enumerations.MeasurementSystem.yml\" sourcestartlinenumber=\"1\">An enumeration representing different measurement systems.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Enumerations.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Enumerations.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Enumerations",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.EventLevel.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.EventLevel.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.EventLevel",
"Summary": "<p sourcefile=\"api/CapyKit.EventLevel.yml\" sourcestartlinenumber=\"1\">Enumeration representing different event level severity values.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Extensions.EnumerationExtensions.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Extensions.EnumerationExtensions",
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.EnumerationExtensions.yml\" sourcestartlinenumber=\"1\">Provides static extentions methods for providing additional functionality for <xref href=\"System.Enum\" data-throw-if-not-resolved=\"false\"></xref> types.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Extensions.LINQExtensions.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Extensions.LINQExtensions",
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.LINQExtensions.yml\" sourcestartlinenumber=\"1\">Provides static extension methods for performing common LINQ operations on <xref href=\"System.Collections.Generic.IEnumerable%601\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"System.Linq.IQueryable%601\" data-throw-if-not-resolved=\"false\"></xref> collections.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Extensions.ObjectExtensions.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Extensions.ObjectExtensions",
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.ObjectExtensions.yml\" sourcestartlinenumber=\"1\">An class containing extenstions that apply to any object type.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Extensions.StringExtensions.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Extensions.StringExtensions",
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.StringExtensions.yml\" sourcestartlinenumber=\"1\">Provides static extentions methods for providing additional functionality for <xref href=\"System.String\" data-throw-if-not-resolved=\"false\"></xref> types.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Extensions.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Extensions.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Extensions",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.CalculationHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.CalculationHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.CalculationHelper.yml\" sourcestartlinenumber=\"1\">Static class providing helper methods for various calculations.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.CompressionHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.CompressionHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.CompressionHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing data compression.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.EncryptionHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.EncryptionHelper",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.IEncryptionAlgorithm",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.KeyHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.KeyHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.KeyHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing key creation and validation against a master key.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.LanguageHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.LanguageHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.LanguageHelper.yml\" sourcestartlinenumber=\"1\">Helper class for handling text transformations.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.SecurityHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.SecurityHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.SecurityHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing secure data processing and cryptography.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.SerializationHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.SerializationHelper",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.SettingsHelper.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.SettingsHelper",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.SettingsHelper.yml\" sourcestartlinenumber=\"1\">Static class containing helper methods for retrieving and setting application settings.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers.ValidCharacterCollection",
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.ValidCharacterCollection.yml\" sourcestartlinenumber=\"1\">An enumeration that defines the types of characters that can be included in a random string.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Helpers.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Helpers.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Helpers",
"Summary": null
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.IPasswordAlgorithm.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.IPasswordAlgorithm",
"Summary": "<p sourcefile=\"api/CapyKit.IPasswordAlgorithm.yml\" sourcestartlinenumber=\"1\">Defines the contract for password encryption algorithms.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.NamedColor.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.NamedColor.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.NamedColor",
"Summary": "<p sourcefile=\"api/CapyKit.NamedColor.yml\" sourcestartlinenumber=\"1\">Enum representing a set of named colors with their corresponding HEX values. These colors are\ninspired by the XKCD color palette (<a href=\"https://xkcd.com/color/rgb/\" target=\"_blank\">Link</a>).</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Password.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Password.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Password",
"Summary": "<p sourcefile=\"api/CapyKit.Password.yml\" sourcestartlinenumber=\"1\">Represents a password with its hash, salt and algorithm used for encryption.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Pbkdf2Algorithm.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Pbkdf2Algorithm",
"Summary": "<p sourcefile=\"api/CapyKit.Pbkdf2Algorithm.yml\" sourcestartlinenumber=\"1\">Implements the PBKDF2 algorithm for password encryption.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.Pool-1.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.Pool-1.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.Pool<T>",
"Summary": "<p sourcefile=\"api/CapyKit.Pool-1.yml\" sourcestartlinenumber=\"1\">A managed pool of resources. This class provides a thread-safe way to manage a collection of\nobjects of type <code class=\"typeparamref\">T</code>.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.PoolItem-1.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.PoolItem-1.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.PoolItem<T>",
"Summary": "<p sourcefile=\"api/CapyKit.PoolItem-1.yml\" sourcestartlinenumber=\"1\">A pool item. This class cannot be inherited.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.PropertyComparer-2.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.PropertyComparer-2.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit.PropertyComparer<T, U>",
"Summary": "<p sourcefile=\"api/CapyKit.PropertyComparer-2.yml\" sourcestartlinenumber=\"1\">A object comparer that can accept a lambda expression to compare properties.</p>\n"
},
{
"type": "ManagedReference",
"source_relative_path": "api/CapyKit.yml",
"output": {
".html": {
"relative_path": "api/CapyKit.html"
}
},
"version": "",
"Uid": null,
"IsMRef": true,
"Title": "CapyKit",
"Summary": null
},
{
"type": "Toc",
"source_relative_path": "api/toc.yml",
"output": {
".html": {
"relative_path": "api/toc.html"
},
".json": {
"relative_path": "api/toc.json"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "getting-started.md",
"output": {
".html": {
"relative_path": "getting-started.html"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "index.md",
"output": {
".html": {
"relative_path": "index.html"
}
},
"version": ""
},
{
"type": "Conceptual",
"source_relative_path": "introduction.md",
"output": {
".html": {
"relative_path": "introduction.html"
}
},
"version": ""
},
{
"type": "Toc",
"source_relative_path": "toc.yml",
"output": {
".html": {
"relative_path": "toc.html"
},
".json": {
"relative_path": "toc.json"
}
},
"version": ""
}
],
"groups": [
{
"xrefmap": "xrefmap.yml"
}
]
}