Skip to content

Commit

Permalink
Update release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 25, 2024
1 parent 7136b7e commit 32cecca
Show file tree
Hide file tree
Showing 660 changed files with 33,121 additions and 2,782 deletions.
12 changes: 6 additions & 6 deletions release/api/Dec.AbstractAttribute.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
Expand All @@ -16,7 +16,7 @@



<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.7.1/apiSpec/new?filename=Dec_AbstractAttribute.md&amp;value=---%0Auid%3A%20Dec.AbstractAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.8.0/apiSpec/new?filename=Dec_AbstractAttribute.md&amp;value=---%0Auid%3A%20Dec.AbstractAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -85,7 +85,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="Dec_AbstractAttribute" data-uid="Dec.AbstractAttribute" class="text-break">
Class AbstractAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Attributes.cs/#L38"><i class="bi bi-code-slash"></i></a>
Class AbstractAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L38"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand All @@ -108,8 +108,8 @@ <h1 id="Dec_AbstractAttribute" data-uid="Dec.AbstractAttribute" class="text-brea
<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.attribute">Attribute</a></div>
<div><span class="xref">object</span></div>
<div><span class="xref">Attribute</span></div>
<div><span class="xref">AbstractAttribute</span></div>
</dd>
</dl>
Expand All @@ -129,7 +129,7 @@ <h2 id="Dec_AbstractAttribute_remarks">Remarks</h2>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Attributes.cs/#L38" class="edit-link">Edit this page</a>
<a href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L38" class="edit-link">Edit this page</a>
</div>


Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!DOCTYPE html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class CloneWithAssignmentAttribute </title>
<title>Class CloneClassAsSharedRef </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CloneWithAssignmentAttribute ">
<meta name="title" content="Class CloneClassAsSharedRef ">

<meta name="description" content="Signals that class should be cloned with standard assignment.">
<meta name="description" content="Signals that this class should be &amp;quot;cloned&amp;quot; by simply duplicating the reference.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
Expand All @@ -16,7 +16,7 @@



<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.7.1/apiSpec/new?filename=Dec_CloneWithAssignmentAttribute.md&amp;value=---%0Auid%3A%20Dec.CloneWithAssignmentAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.8.0/apiSpec/new?filename=Dec_CloneClassAsSharedRef.md&amp;value=---%0Auid%3A%20Dec.CloneClassAsSharedRef%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -80,26 +80,26 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<nav id="breadcrumb"></nav>
</div>

<article data-uid="Dec.CloneWithAssignmentAttribute">
<article data-uid="Dec.CloneClassAsSharedRef">



<h1 id="Dec_CloneWithAssignmentAttribute" data-uid="Dec.CloneWithAssignmentAttribute" class="text-break">
Class CloneWithAssignmentAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Attributes.cs/#L52"><i class="bi bi-code-slash"></i></a>
<h1 id="Dec_CloneClassAsSharedRef" data-uid="Dec.CloneClassAsSharedRef" class="text-break">
Class CloneClassAsSharedRef <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L62"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Dec.html">Dec</a></dd></dl>
<dl><dt>Assembly</dt><dd>dec.dll</dd></dl>
</div>

<div class="markdown summary"><p>Signals that class should be cloned with standard assignment.</p>
<div class="markdown summary"><p>Signals that this class should be &quot;cloned&quot; by simply duplicating the reference.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class|AttributeTargets.Struct)]
public class CloneWithAssignmentAttribute : Attribute</code></pre>
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class)]
public class CloneClassAsSharedRef : Attribute</code></pre>
</div>


Expand All @@ -108,9 +108,9 @@ <h1 id="Dec_CloneWithAssignmentAttribute" data-uid="Dec.CloneWithAssignmentAttri
<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.attribute">Attribute</a></div>
<div><span class="xref">CloneWithAssignmentAttribute</span></div>
<div><span class="xref">object</span></div>
<div><span class="xref">Attribute</span></div>
<div><span class="xref">CloneClassAsSharedRef</span></div>
</dd>
</dl>

Expand All @@ -120,17 +120,16 @@ <h1 id="Dec_CloneWithAssignmentAttribute" data-uid="Dec.CloneWithAssignmentAttri



<h2 id="Dec_CloneWithAssignmentAttribute_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>This is most useful for collections of objects, where it can rely on the collection's own cloning behavior to clone a vast swath of objects at once.</p>
<p>For structs, this becomes a shallow copy. For classes, this becomes a reference copy.</p>
<h2 id="Dec_CloneClassAsSharedRef_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>This is (obviously) much faster than copying the class, though it also (obviously) leaves you with a &quot;clone&quot; that shares state with the original. Great for immutable classes or classes wrapped in copy-on-write structures.</p>
</div>



</article>

<div class="contribution d-print-none">
<a href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Attributes.cs/#L52" class="edit-link">Edit this page</a>
<a href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L62" class="edit-link">Edit this page</a>
</div>


Expand Down
152 changes: 152 additions & 0 deletions release/api/Dec.CloneStructPiecewiseAttribute.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class CloneStructPiecewiseAttribute </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class CloneStructPiecewiseAttribute ">

<meta name="description" content="Signals that this struct should be cloned with standard shallow-copy assignment semantics.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">




<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.8.0/apiSpec/new?filename=Dec_CloneStructPiecewiseAttribute.md&amp;value=---%0Auid%3A%20Dec.CloneStructPiecewiseAttribute%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">

<script type="module" src="./../public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

</head>

<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">

</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
</div>
</div>
</div>
</nav>
</header>

<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>

<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>

<nav id="breadcrumb"></nav>
</div>

<article data-uid="Dec.CloneStructPiecewiseAttribute">



<h1 id="Dec_CloneStructPiecewiseAttribute" data-uid="Dec.CloneStructPiecewiseAttribute" class="text-break">
Class CloneStructPiecewiseAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L50"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Dec.html">Dec</a></dd></dl>
<dl><dt>Assembly</dt><dd>dec.dll</dd></dl>
</div>

<div class="markdown summary"><p>Signals that this struct should be cloned with standard shallow-copy assignment semantics.</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Struct)]
public class CloneStructPiecewiseAttribute : Attribute</code></pre>
</div>




<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><span class="xref">object</span></div>
<div><span class="xref">Attribute</span></div>
<div><span class="xref">CloneStructPiecewiseAttribute</span></div>
</dd>
</dl>







<h2 id="Dec_CloneStructPiecewiseAttribute_remarks">Remarks</h2>
<div class="markdown level0 remarks"><p>This is potentially much faster than using IRecordable to accomplish the same thing, especially if the struct is in a collection of some kind.</p>
</div>



</article>

<div class="contribution d-print-none">
<a href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Attributes.cs/#L50" class="edit-link">Edit this page</a>
</div>


</div>

<div class="affix">
<nav id="affix"></nav>
</div>
</main>


<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>
14 changes: 7 additions & 7 deletions release/api/Dec.Composer.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
Expand All @@ -16,7 +16,7 @@



<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.7.1/apiSpec/new?filename=Dec_Composer.md&amp;value=---%0Auid%3A%20Dec.Composer%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.8.0/apiSpec/new?filename=Dec_Composer.md&amp;value=---%0Auid%3A%20Dec.Composer%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -85,7 +85,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="Dec_Composer" data-uid="Dec.Composer" class="text-break">
Class Composer <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Composer.cs/#L11"><i class="bi bi-code-slash"></i></a>
Class Composer <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Composer.cs/#L9"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand All @@ -107,7 +107,7 @@ <h1 id="Dec_Composer" data-uid="Dec.Composer" class="text-break">
<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">object</span></div>
<div><span class="xref">Composer</span></div>
</dd>
</dl>
Expand All @@ -131,7 +131,7 @@ <h2 class="section" id="methods">Methods

<h3 id="Dec_Composer_ComposeValidation_Dec_Recorder_IUserSettings_" data-uid="Dec.Composer.ComposeValidation(Dec.Recorder.IUserSettings)">
ComposeValidation(IUserSettings)
<a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Composer.cs/#L28"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Composer.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
Expand Down Expand Up @@ -167,7 +167,7 @@ <h4 class="section">Returns</h4>

<h3 id="Dec_Composer_ComposeXml_System_Boolean_Dec_Recorder_IUserSettings_" data-uid="Dec.Composer.ComposeXml(System.Boolean,Dec.Recorder.IUserSettings)">
ComposeXml(bool, IUserSettings)
<a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Composer.cs/#L13"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Composer.cs/#L11"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
Expand Down Expand Up @@ -205,7 +205,7 @@ <h4 class="section">Returns</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Composer.cs/#L11" class="edit-link">Edit this page</a>
<a href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Composer.cs/#L9" class="edit-link">Edit this page</a>
</div>


Expand Down
8 changes: 4 additions & 4 deletions release/api/Dec.Config.DefaultExceptionBehavior.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
Expand All @@ -16,7 +16,7 @@



<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.7.1/apiSpec/new?filename=Dec_Config_DefaultExceptionBehavior.md&amp;value=---%0Auid%3A%20Dec.Config.DefaultExceptionBehavior%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="docfx:docurl" content="https://github.com/zorbathut/dec/new/v0.8.0/apiSpec/new?filename=Dec_Config_DefaultExceptionBehavior.md&amp;value=---%0Auid%3A%20Dec.Config.DefaultExceptionBehavior%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
Expand Down Expand Up @@ -86,7 +86,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="Dec_Config_DefaultExceptionBehavior" data-uid="Dec.Config.DefaultExceptionBehavior" class="text-break">
Enum Config.DefaultExceptionBehavior <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Config.cs/#L61"><i class="bi bi-code-slash"></i></a>
Enum Config.DefaultExceptionBehavior <a class="header-action link-secondary" title="View source" href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Config.cs/#L61"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -125,7 +125,7 @@ <h2 id="fields">Fields
</article>

<div class="contribution d-print-none">
<a href="https://github.com/zorbathut/dec/blob/v0.7.1/src/Config.cs/#L61" class="edit-link">Edit this page</a>
<a href="https://github.com/zorbathut/dec/blob/v0.8.0/src/Config.cs/#L61" class="edit-link">Edit this page</a>
</div>


Expand Down
Loading

0 comments on commit 32cecca

Please sign in to comment.