Skip to content

Commit 1c8d777

Browse files
committed
Update project documentations
1 parent 56367df commit 1c8d777

File tree

42 files changed

+570
-1331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+570
-1331
lines changed

JsonSchema/RelogicLabs/JsonSchema/Utilities/CommonUtilities.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
namespace RelogicLabs.JsonSchema.Utilities;
44

5-
public static class CommonUtilities
5+
internal static class CommonUtilities
66
{
77
public static T NonNull<T>(T? value)
88
=> value ?? throw new NullReferenceException("Required reference not set to an instance");

JsonSchema/docs/api/RelogicLabs.JsonSchema.Collections.IIndexMap-2.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,21 +263,26 @@ <h2 class="section" id="methods">Methods
263263
</h2>
264264

265265

266-
<a id="RelogicLabs_JsonSchema_Collections_IIndexMap_2_MakeReadOnly_" data-uid="RelogicLabs.JsonSchema.Collections.IIndexMap`2.MakeReadOnly*"></a>
266+
<a id="RelogicLabs_JsonSchema_Collections_IIndexMap_2_AsReadOnly_" data-uid="RelogicLabs.JsonSchema.Collections.IIndexMap`2.AsReadOnly*"></a>
267267

268-
<h3 id="RelogicLabs_JsonSchema_Collections_IIndexMap_2_MakeReadOnly" data-uid="RelogicLabs.JsonSchema.Collections.IIndexMap`2.MakeReadOnly">
269-
MakeReadOnly()
268+
<h3 id="RelogicLabs_JsonSchema_Collections_IIndexMap_2_AsReadOnly" data-uid="RelogicLabs.JsonSchema.Collections.IIndexMap`2.AsReadOnly">
269+
AsReadOnly()
270270
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Collections/IIndexMap.cs/#L10"><i class="bi bi-code-slash"></i></a>
271271
</h3>
272272

273273
<div class="markdown level1 summary"></div>
274274
<div class="markdown level1 conceptual"></div>
275275

276276
<div class="codewrapper">
277-
<pre><code class="lang-csharp hljs">void MakeReadOnly()</code></pre>
277+
<pre><code class="lang-csharp hljs">IIndexMap&lt;TK, TV&gt; AsReadOnly()</code></pre>
278278
</div>
279279

280280

281+
<h4 class="section">Returns</h4>
282+
<dl class="parameters">
283+
<dt><a class="xref" href="RelogicLabs.JsonSchema.Collections.IIndexMap-2.html">IIndexMap</a>&lt;TK, TV&gt;</dt>
284+
<dd></dd>
285+
</dl>
281286

282287

283288

JsonSchema/docs/api/RelogicLabs.JsonSchema.Collections.IndexHashMap-2.html

Lines changed: 50 additions & 45 deletions
Large diffs are not rendered by default.

JsonSchema/docs/api/RelogicLabs.JsonSchema.Functions.CoreFunctions.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8383

8484
<h1 id="RelogicLabs_JsonSchema_Functions_CoreFunctions" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions" class="text-break">
8585
Class CoreFunctions
86-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/docs/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs/#L30"><i class="bi bi-code-slash"></i></a>
86+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L11"><i class="bi bi-code-slash"></i></a>
8787
</h1>
8888

8989
<div class="facts text-secondary">
@@ -195,7 +195,7 @@ <h2 class="section" id="methods">Methods
195195

196196
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Date_RelogicLabs_JsonSchema_Types_JString_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Date(RelogicLabs.JsonSchema.Types.JString,RelogicLabs.JsonSchema.Types.JString)">
197197
Date(JString, JString)
198-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L119"><i class="bi bi-code-slash"></i></a>
198+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L126"><i class="bi bi-code-slash"></i></a>
199199
</h3>
200200

201201
<div class="markdown level1 summary"></div>
@@ -233,7 +233,7 @@ <h4 class="section">Returns</h4>
233233

234234
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Elements_RelogicLabs_JsonSchema_Types_JArray_RelogicLabs_JsonSchema_Types_JNode___" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Elements(RelogicLabs.JsonSchema.Types.JArray,RelogicLabs.JsonSchema.Types.JNode[])">
235235
Elements(JArray, params JNode[])
236-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L13"><i class="bi bi-code-slash"></i></a>
236+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L20"><i class="bi bi-code-slash"></i></a>
237237
</h3>
238238

239239
<div class="markdown level1 summary"></div>
@@ -271,7 +271,7 @@ <h4 class="section">Returns</h4>
271271

272272
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Email_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Email(RelogicLabs.JsonSchema.Types.JString)">
273273
Email(JString)
274-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L66"><i class="bi bi-code-slash"></i></a>
274+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L73"><i class="bi bi-code-slash"></i></a>
275275
</h3>
276276

277277
<div class="markdown level1 summary"></div>
@@ -383,7 +383,7 @@ <h4 class="section">Returns</h4>
383383

384384
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Keys_RelogicLabs_JsonSchema_Types_JObject_RelogicLabs_JsonSchema_Types_JString___" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Keys(RelogicLabs.JsonSchema.Types.JObject,RelogicLabs.JsonSchema.Types.JString[])">
385385
Keys(JObject, params JString[])
386-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L27"><i class="bi bi-code-slash"></i></a>
386+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L34"><i class="bi bi-code-slash"></i></a>
387387
</h3>
388388

389389
<div class="markdown level1 summary"></div>
@@ -1195,7 +1195,7 @@ <h4 class="section">Returns</h4>
11951195

11961196
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Phone_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Phone(RelogicLabs.JsonSchema.Types.JString)">
11971197
Phone(JString)
1198-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L109"><i class="bi bi-code-slash"></i></a>
1198+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L116"><i class="bi bi-code-slash"></i></a>
11991199
</h3>
12001200

12011201
<div class="markdown level1 summary"></div>
@@ -1387,7 +1387,7 @@ <h4 class="section">Returns</h4>
13871387

13881388
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Regex_RelogicLabs_JsonSchema_Types_JString_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Regex(RelogicLabs.JsonSchema.Types.JString,RelogicLabs.JsonSchema.Types.JString)">
13891389
Regex(JString, JString)
1390-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L55"><i class="bi bi-code-slash"></i></a>
1390+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L62"><i class="bi bi-code-slash"></i></a>
13911391
</h3>
13921392

13931393
<div class="markdown level1 summary"></div>
@@ -1425,7 +1425,7 @@ <h4 class="section">Returns</h4>
14251425

14261426
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Time_RelogicLabs_JsonSchema_Types_JString_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Time(RelogicLabs.JsonSchema.Types.JString,RelogicLabs.JsonSchema.Types.JString)">
14271427
Time(JString, JString)
1428-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L122"><i class="bi bi-code-slash"></i></a>
1428+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L129"><i class="bi bi-code-slash"></i></a>
14291429
</h3>
14301430

14311431
<div class="markdown level1 summary"></div>
@@ -1463,7 +1463,7 @@ <h4 class="section">Returns</h4>
14631463

14641464
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Url_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Url(RelogicLabs.JsonSchema.Types.JString)">
14651465
Url(JString)
1466-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L76"><i class="bi bi-code-slash"></i></a>
1466+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L83"><i class="bi bi-code-slash"></i></a>
14671467
</h3>
14681468

14691469
<div class="markdown level1 summary"></div>
@@ -1499,7 +1499,7 @@ <h4 class="section">Returns</h4>
14991499

15001500
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Url_RelogicLabs_JsonSchema_Types_JString_RelogicLabs_JsonSchema_Types_JString_" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Url(RelogicLabs.JsonSchema.Types.JString,RelogicLabs.JsonSchema.Types.JString)">
15011501
Url(JString, JString)
1502-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L93"><i class="bi bi-code-slash"></i></a>
1502+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L100"><i class="bi bi-code-slash"></i></a>
15031503
</h3>
15041504

15051505
<div class="markdown level1 summary"></div>
@@ -1537,7 +1537,7 @@ <h4 class="section">Returns</h4>
15371537

15381538
<h3 id="RelogicLabs_JsonSchema_Functions_CoreFunctions_Values_RelogicLabs_JsonSchema_Types_JObject_RelogicLabs_JsonSchema_Types_JNode___" data-uid="RelogicLabs.JsonSchema.Functions.CoreFunctions.Values(RelogicLabs.JsonSchema.Types.JObject,RelogicLabs.JsonSchema.Types.JNode[])">
15391539
Values(JObject, params JNode[])
1540-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L41"><i class="bi bi-code-slash"></i></a>
1540+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L48"><i class="bi bi-code-slash"></i></a>
15411541
</h3>
15421542

15431543
<div class="markdown level1 summary"></div>
@@ -1575,7 +1575,7 @@ <h4 class="section">Returns</h4>
15751575
</article>
15761576

15771577
<div class="contribution d-print-none">
1578-
<a href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/docs/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs/#L30" class="edit-link">Edit this page</a>
1578+
<a href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Functions/CoreFunctions3.cs/#L11" class="edit-link">Edit this page</a>
15791579
</div>
15801580

15811581

JsonSchema/docs/api/RelogicLabs.JsonSchema.Functions.FunctionBase.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ <h3 id="RelogicLabs_JsonSchema_Functions_FunctionBase_Runtime" data-uid="Relogic
229229
<div class="markdown level1 conceptual"></div>
230230

231231
<div class="codewrapper">
232-
<pre><code class="lang-csharp hljs">public required RuntimeContext Runtime { get; init; }</code></pre>
232+
<pre><code class="lang-csharp hljs">public RuntimeContext Runtime { get; }</code></pre>
233233
</div>
234234

235235

JsonSchema/docs/api/RelogicLabs.JsonSchema.Message.ActualDetail.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
8383

8484
<h1 id="RelogicLabs_JsonSchema_Message_ActualDetail" data-uid="RelogicLabs.JsonSchema.Message.ActualDetail" class="text-break">
8585
Class ActualDetail
86-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L8"><i class="bi bi-code-slash"></i></a>
86+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L7"><i class="bi bi-code-slash"></i></a>
8787
</h1>
8888

8989
<div class="facts text-secondary">
@@ -160,7 +160,7 @@ <h2 class="section" id="constructors">Constructors
160160

161161
<h3 id="RelogicLabs_JsonSchema_Message_ActualDetail__ctor_RelogicLabs_JsonSchema_Tree_Context_System_String_" data-uid="RelogicLabs.JsonSchema.Message.ActualDetail.#ctor(RelogicLabs.JsonSchema.Tree.Context,System.String)">
162162
ActualDetail(Context, string)
163-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L10"><i class="bi bi-code-slash"></i></a>
163+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L9"><i class="bi bi-code-slash"></i></a>
164164
</h3>
165165

166166
<div class="markdown level1 summary"></div>
@@ -193,7 +193,7 @@ <h4 class="section">Parameters</h4>
193193

194194
<h3 id="RelogicLabs_JsonSchema_Message_ActualDetail__ctor_RelogicLabs_JsonSchema_Types_JNode_System_String_" data-uid="RelogicLabs.JsonSchema.Message.ActualDetail.#ctor(RelogicLabs.JsonSchema.Types.JNode,System.String)">
195195
ActualDetail(JNode, string)
196-
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L14"><i class="bi bi-code-slash"></i></a>
196+
<a class="header-action link-secondary" title="View source" href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L12"><i class="bi bi-code-slash"></i></a>
197197
</h3>
198198

199199
<div class="markdown level1 summary"></div>
@@ -226,7 +226,7 @@ <h4 class="section">Parameters</h4>
226226
</article>
227227

228228
<div class="contribution d-print-none">
229-
<a href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L8" class="edit-link">Edit this page</a>
229+
<a href="https://github.com/relogiclabs/JsonSchema-DotNet/blob/develop/JsonSchema/RelogicLabs/JsonSchema/Message/ActualDetail.cs/#L7" class="edit-link">Edit this page</a>
230230
</div>
231231

232232

0 commit comments

Comments
 (0)