{ "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", "Summary": "

Custom attribute class for decorating enumeration fields with additional data.

\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": "

An attribute class for decorating enumeration fields with a description.

\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": "

Custom attribute for formatting values in a specific way.

\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": "

The CapyEventArgs class represents an event argument instance with event level, message, and\nmethod name information.

\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": "

A delegate representing an event handler that accepts a instance.

\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": "

The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.

\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": "

An object representing a color.

\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", "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": "

An enumeration representing different measurement systems.

\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": "

Enumeration representing different event level severity values.

\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": "

Provides static extentions methods for providing additional functionality for types.

\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": "

Provides static extension methods for performing common LINQ operations on and collections.

\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": "

An class containing extenstions that apply to any object type.

\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": "

Provides static extentions methods for providing additional functionality for types.

\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": "

Static class providing helper methods for various calculations.

\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": "

A class that contains methods for managing data compression.

\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": "

A class that contains methods for managing key creation and validation against a master key.

\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": "

Helper class for handling text transformations.

\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": "

A class that contains methods for managing secure data processing and cryptography.

\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": "

Static class containing helper methods for retrieving and setting application settings.

\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": "

An enumeration that defines the types of characters that can be included in a random string.

\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": "

Defines the contract for password encryption algorithms.

\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": "

Enum representing a set of named colors with their corresponding HEX values. These colors are\ninspired by the XKCD color palette (Link).

\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": "

Represents a password with its hash, salt and algorithm used for encryption.

\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": "

Implements the PBKDF2 algorithm for password encryption.

\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", "Summary": "

A managed pool of resources. This class provides a thread-safe way to manage a collection of\nobjects of type T.

\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", "Summary": "

A pool item. This class cannot be inherited.

\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", "Summary": "

A object comparer that can accept a lambda expression to compare properties.

\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" } ] }