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 CapyEventArgs | CapyKit Documentation </title>
|
||||
<title> Class CapyEventArgs | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CapyEventArgs | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CapyEventArgs | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="The CapyEventArgs class represents an event argument instance with event level, message, and method name information.">
|
||||
<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,235 +70,69 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.CapyEventArgs">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_CapyEventArgs"> Class CapyEventArgs</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_CapyEventArgs" data-uid="CapyKit.CapyEventArgs" class="text-break">
|
||||
Class CapyEventArgs
|
||||
</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>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CapyEventArgs : EventArgs</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><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a></div>
|
||||
<div><span class="xref">CapyEventArgs</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.eventargs.empty">EventArgs.Empty</a>
|
||||
</div>
|
||||
<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>
|
||||
|
||||
<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<T>(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_CapyEventArgs__ctor_" data-uid="CapyKit.CapyEventArgs.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_" data-uid="CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)">
|
||||
CapyEventArgs(EventLevel, string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CapyEventArgs(EventLevel level, string message, string method = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>level</code> <a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>The severity level of the event.</p>
|
||||
</dd>
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A descriptive message explaining the reason for the event.</p>
|
||||
</dd>
|
||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the method where the event was raised.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_Level_" data-uid="CapyKit.CapyEventArgs.Level*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_Level" data-uid="CapyKit.CapyEventArgs.Level">
|
||||
Level
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the severity level of the event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EventLevel Level { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_Message_" data-uid="CapyKit.CapyEventArgs.Message*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_Message" data-uid="CapyKit.CapyEventArgs.Message">
|
||||
Message
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the message describing the reason for the event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Message { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_MethodName_" data-uid="CapyKit.CapyEventArgs.MethodName*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_MethodName" data-uid="CapyKit.CapyEventArgs.MethodName">
|
||||
MethodName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the method where the event was raised.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string MethodName { 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.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public class CapyEventArgs : EventArgs
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a> ←
|
||||
<a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.eventargs.empty">EventArgs.Empty</a>,
|
||||
<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<CapyEventArgs>(CapyEventArgs, CapyEventArgs)</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_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_"> CapyEventArgs(EventLevel, string, string)</h3>
|
||||
<p>Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.</p>
|
||||
<pre><code class="lang-csharp">public CapyEventArgs(EventLevel level, string message, string method = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>level</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A descriptive message explaining the reason for the event.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the method where the event was raised.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_CapyEventArgs_Level"> Level</h3>
|
||||
<p>Gets the severity level of the event.</p>
|
||||
<pre><code class="lang-csharp">public EventLevel Level { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_Message"> Message</h3>
|
||||
<p>Gets the message describing the reason for the event.</p>
|
||||
<pre><code class="lang-csharp">public string Message { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_MethodName"> MethodName</h3>
|
||||
<p>Gets the name of the method where the event was raised.</p>
|
||||
<pre><code class="lang-csharp">public string MethodName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></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