Skip to content

Commit 1e6e5fc

Browse files
committed
Auto-generated documentation from ba3accf
1 parent b497806 commit 1e6e5fc

6 files changed

+504
-450
lines changed

api/JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ <h2 class="section" id="methods">Methods
258258

259259
<h3 id="JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_Accept__2_JsonApiDotNetCore_Queries_Expressions_QueryExpressionVisitor___0___1____0_" data-uid="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.Accept``2(JsonApiDotNetCore.Queries.Expressions.QueryExpressionVisitor{``0,``1},``0)">
260260
Accept&lt;TArgument, TResult&gt;(QueryExpressionVisitor&lt;TArgument, TResult&gt;, TArgument)
261-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L41"><i class="bi bi-code-slash"></i></a>
261+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L43"><i class="bi bi-code-slash"></i></a>
262262
</h3>
263263

264264
<div class="markdown level1 summary"></div>
@@ -303,7 +303,7 @@ <h4 class="section">Type Parameters</h4>
303303

304304
<h3 id="JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_Equals_System_Object_" data-uid="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.Equals(System.Object)">
305305
Equals(object?)
306-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L57"><i class="bi bi-code-slash"></i></a>
306+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L59"><i class="bi bi-code-slash"></i></a>
307307
</h3>
308308

309309
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
@@ -342,7 +342,7 @@ <h4 class="section">Returns</h4>
342342

343343
<h3 id="JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_GetHashCode" data-uid="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.GetHashCode">
344344
GetHashCode()
345-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L74"><i class="bi bi-code-slash"></i></a>
345+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L76"><i class="bi bi-code-slash"></i></a>
346346
</h3>
347347

348348
<div class="markdown level1 summary"><p>Serves as the default hash function.</p>
@@ -375,7 +375,7 @@ <h4 class="section">Returns</h4>
375375

376376
<h3 id="JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_ToFullString" data-uid="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.ToFullString">
377377
ToFullString()
378-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L52"><i class="bi bi-code-slash"></i></a>
378+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L54"><i class="bi bi-code-slash"></i></a>
379379
</h3>
380380

381381
<div class="markdown level1 summary"></div>
@@ -406,7 +406,7 @@ <h4 class="section">Returns</h4>
406406

407407
<h3 id="JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_ToString" data-uid="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.ToString">
408408
ToString()
409-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L46"><i class="bi bi-code-slash"></i></a>
409+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/LiteralConstantExpression.cs/#L48"><i class="bi bi-code-slash"></i></a>
410410
</h3>
411411

412412
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>

api/JsonApiDotNetCore.Queries.Parsing.FilterParser.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ <h4 class="section">Returns</h4>
308308

309309
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_InScopeOfResourceType_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.InScopeOfResourceType(JsonApiDotNetCore.Configuration.ResourceType)">
310310
InScopeOfResourceType(ResourceType)
311-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L581"><i class="bi bi-code-slash"></i></a>
311+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L582"><i class="bi bi-code-slash"></i></a>
312312
</h3>
313313

314314
<div class="markdown level1 summary"><p>Changes the resource type currently in scope and restores the original resource type when the return value is disposed.</p>
@@ -716,7 +716,7 @@ <h4 class="section">Returns</h4>
716716

717717
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_ValidateField_JsonApiDotNetCore_Resources_Annotations_ResourceFieldAttribute_System_Int32_" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.ValidateField(JsonApiDotNetCore.Resources.Annotations.ResourceFieldAttribute,System.Int32)">
718718
ValidateField(ResourceFieldAttribute, int)
719-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L567"><i class="bi bi-code-slash"></i></a>
719+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L568"><i class="bi bi-code-slash"></i></a>
720720
</h3>
721721

722722
<div class="markdown level1 summary"><p>Enables derived types to throw a <a class="xref" href="JsonApiDotNetCore.Queries.Parsing.QueryParseException.html">QueryParseException</a> when usage of a JSON:API field inside a field chain is not permitted.</p>

api/JsonApiDotNetCore.Resources.RuntimeTypeConverter.html

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ <h2 class="section" id="methods">Methods
161161

162162
<h3 id="JsonApiDotNetCore_Resources_RuntimeTypeConverter_CanContainNull_System_Type_" data-uid="JsonApiDotNetCore.Resources.RuntimeTypeConverter.CanContainNull(System.Type)">
163163
CanContainNull(Type)
164-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs/#L141"><i class="bi bi-code-slash"></i></a>
164+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs/#L148"><i class="bi bi-code-slash"></i></a>
165165
</h3>
166166

167167
<div class="markdown level1 summary"><p>Indicates whether the specified type is a nullable value type or a reference type.</p>
@@ -246,7 +246,7 @@ <h4 class="section">Exceptions</h4>
246246

247247
<h3 id="JsonApiDotNetCore_Resources_RuntimeTypeConverter_GetDefaultValue_System_Type_" data-uid="JsonApiDotNetCore.Resources.RuntimeTypeConverter.GetDefaultValue(System.Type)">
248248
GetDefaultValue(Type)
249-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs/#L154"><i class="bi bi-code-slash"></i></a>
249+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs/#L161"><i class="bi bi-code-slash"></i></a>
250250
</h3>
251251

252252
<div class="markdown level1 summary"><p>Gets the default value for the specified type.</p>
@@ -280,6 +280,45 @@ <h4 class="section">Returns</h4>
280280

281281

282282

283+
<a id="JsonApiDotNetCore_Resources_RuntimeTypeConverter_GetFriendlyTypeName_" data-uid="JsonApiDotNetCore.Resources.RuntimeTypeConverter.GetFriendlyTypeName*"></a>
284+
285+
<h3 id="JsonApiDotNetCore_Resources_RuntimeTypeConverter_GetFriendlyTypeName_System_Type_" data-uid="JsonApiDotNetCore.Resources.RuntimeTypeConverter.GetFriendlyTypeName(System.Type)">
286+
GetFriendlyTypeName(Type)
287+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Resources/RuntimeTypeConverter.cs/#L176"><i class="bi bi-code-slash"></i></a>
288+
</h3>
289+
290+
<div class="markdown level1 summary"><p>Gets the name of a type, including the names of its generic type arguments, without any namespaces.
291+
<example>
292+
<pre><code class="lang-csharp">KeyValuePair&lt;TimeSpan, Nullable&lt;DateTimeOffset&gt;&gt;</code></pre></example></p>
293+
</div>
294+
<div class="markdown level1 conceptual"></div>
295+
296+
<div class="codewrapper">
297+
<pre><code class="lang-csharp hljs">public static string GetFriendlyTypeName(Type type)</code></pre>
298+
</div>
299+
300+
<h4 class="section">Parameters</h4>
301+
<dl class="parameters">
302+
<dt><code>type</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
303+
<dd></dd>
304+
</dl>
305+
306+
<h4 class="section">Returns</h4>
307+
<dl class="parameters">
308+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
309+
<dd></dd>
310+
</dl>
311+
312+
313+
314+
315+
316+
317+
318+
319+
320+
321+
283322

284323
</article>
285324

api/JsonApiDotNetCore.Serialization.Request.ModelConversionException.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,16 +190,16 @@ <h2 class="section" id="constructors">Constructors
190190

191191
<a id="JsonApiDotNetCore_Serialization_Request_ModelConversionException__ctor_" data-uid="JsonApiDotNetCore.Serialization.Request.ModelConversionException.#ctor*"></a>
192192

193-
<h3 id="JsonApiDotNetCore_Serialization_Request_ModelConversionException__ctor_JsonApiDotNetCore_Serialization_Request_Adapters_RequestAdapterPosition_System_String_System_String_System_Nullable_System_Net_HttpStatusCode__" data-uid="JsonApiDotNetCore.Serialization.Request.ModelConversionException.#ctor(JsonApiDotNetCore.Serialization.Request.Adapters.RequestAdapterPosition,System.String,System.String,System.Nullable{System.Net.HttpStatusCode})">
194-
ModelConversionException(RequestAdapterPosition, string?, string?, HttpStatusCode?)
193+
<h3 id="JsonApiDotNetCore_Serialization_Request_ModelConversionException__ctor_JsonApiDotNetCore_Serialization_Request_Adapters_RequestAdapterPosition_System_String_System_String_System_Nullable_System_Net_HttpStatusCode__System_Exception_" data-uid="JsonApiDotNetCore.Serialization.Request.ModelConversionException.#ctor(JsonApiDotNetCore.Serialization.Request.Adapters.RequestAdapterPosition,System.String,System.String,System.Nullable{System.Net.HttpStatusCode},System.Exception)">
194+
ModelConversionException(RequestAdapterPosition, string?, string?, HttpStatusCode?, Exception?)
195195
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Serialization/Request/ModelConversionException.cs/#L18"><i class="bi bi-code-slash"></i></a>
196196
</h3>
197197

198198
<div class="markdown level1 summary"></div>
199199
<div class="markdown level1 conceptual"></div>
200200

201201
<div class="codewrapper">
202-
<pre><code class="lang-csharp hljs">public ModelConversionException(RequestAdapterPosition position, string? genericMessage, string? specificMessage, HttpStatusCode? statusCode = null)</code></pre>
202+
<pre><code class="lang-csharp hljs">public ModelConversionException(RequestAdapterPosition position, string? genericMessage, string? specificMessage, HttpStatusCode? statusCode = null, Exception? innerException = null)</code></pre>
203203
</div>
204204

205205
<h4 class="section">Parameters</h4>
@@ -212,6 +212,8 @@ <h4 class="section">Parameters</h4>
212212
<dd></dd>
213213
<dt><code>statusCode</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.net.httpstatuscode">HttpStatusCode</a>?</dt>
214214
<dd></dd>
215+
<dt><code>innerException</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></dt>
216+
<dd></dd>
215217
</dl>
216218

217219

0 commit comments

Comments
 (0)