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 PropertyComparer<T, U> | CapyKit Documentation </title>
|
||||
<title> Class PropertyComparer<T, U> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PropertyComparer<T, U> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class PropertyComparer<T, U> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A object comparer that can accept a lambda expression to compare properties.">
|
||||
<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,95 +70,37 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.PropertyComparer`2">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_PropertyComparer_2"> Class PropertyComparer<T, U></h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_PropertyComparer_2" data-uid="CapyKit.PropertyComparer`2" class="text-break">
|
||||
Class PropertyComparer<T, U>
|
||||
</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>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PropertyComparer<T, U> : IEqualityComparer<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter of the parent object.</p>
|
||||
</dd>
|
||||
<dt><code>U</code></dt>
|
||||
<dd><p>Generic type parameter of the property value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<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">PropertyComparer<T, U></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer</a><T></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)">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 id="CapyKit_PropertyComparer_2_examples">Examples</h2>
|
||||
<p>using System;
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<pre><code class="lang-csharp">public class PropertyComparer<T, U> : IEqualityComparer<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter of the parent object.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter of the property value.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<h4 id="implements">Implements</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer<T></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<PropertyComparer<T, U>>(PropertyComparer<T, U>, PropertyComparer<T, U>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="examples">Examples</h2>
|
||||
<p>using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;</p>
|
||||
<p>class Program
|
||||
|
|
@ -185,147 +127,50 @@ Person { Name = "Charlie", Age = 35 }
|
|||
public string Name { get; set; }
|
||||
public int Age { get; set; }
|
||||
}</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2__ctor_" data-uid="CapyKit.PropertyComparer`2.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__" data-uid="CapyKit.PropertyComparer`2.#ctor(System.Func{`0,`1})">
|
||||
PropertyComparer(Func<T, U>)
|
||||
|
||||
</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 PropertyComparer(Func<T, U> expression)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>expression</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
||||
<dd><p>The expression.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2_Equals_" data-uid="CapyKit.PropertyComparer`2.Equals*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_" data-uid="CapyKit.PropertyComparer`2.Equals(`0,`0)">
|
||||
Equals(T, T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified properties are equal.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(T x, T y)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>x</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
</dd>
|
||||
<dt><code>y</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The second object of type <code class="typeparamref">T</code> to compare.</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 objects are equal; otherwise,
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__"> PropertyComparer(Func<T, U>)</h3>
|
||||
<p>Constructor.</p>
|
||||
<pre><code class="lang-csharp">public PropertyComparer(Func<T, U> expression)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>expression</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>The expression.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_"> Equals(T, T)</h3>
|
||||
<p>Determines whether the specified properties are equal.</p>
|
||||
<pre><code class="lang-csharp">public bool Equals(T x, T y)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>x</code> T</p>
|
||||
<p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
<p><code>y</code> T</p>
|
||||
<p>The second object of type <code class="typeparamref">T</code> to compare.</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 objects are equal; otherwise,
|
||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2_GetHashCode_" data-uid="CapyKit.PropertyComparer`2.GetHashCode*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_" data-uid="CapyKit.PropertyComparer`2.GetHashCode(`0)">
|
||||
GetHashCode(T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a hash code for the specified object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetHashCode(T obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a> for which a hash code is to be returned.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A hash code for the specified object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
|
||||
<dd><p>The type of <code class="paramref">obj</code> is a reference type and
|
||||
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_"> GetHashCode(T)</h3>
|
||||
<p>Returns a hash code for the specified object.</p>
|
||||
<pre><code class="lang-csharp">public int GetHashCode(T obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>obj</code> T</p>
|
||||
<p>The <span class="xref">System.Object</span> for which a hash code is to be returned.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>A hash code for the specified object.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>The type of <code class="paramref">obj</code> is a reference type and
|
||||
<code class="paramref">obj</code> is
|
||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
</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