Skip to content

Commit 2764b34

Browse files
stainless-app[bot]stainless-app[bot]
committed
fix(docs): make xml syntactically correct
1 parent 65880ef commit 2764b34

File tree

274 files changed

+6983
-6897
lines changed

Some content is hidden

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

274 files changed

+6983
-6897
lines changed

‎src/Directory.Build.props‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<!-- Documentation-->
1313
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1414
<!-- Disable missing XML documentation warnings. -->
15-
<NoWarn>$(NoWarn),1570,1573,1574,1591</NoWarn>
15+
<NoWarn>$(NoWarn),1573,1591</NoWarn>
1616

1717
<!-- Source link -->
1818
<PublishRepositoryUrl>true</PublishRepositoryUrl>

‎src/Orb/Core/JsonDictionary.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ namespace Orb.Core;
1111
/// <summary>
1212
/// A dictionary that holds JSON data.
1313
///
14-
/// <para>It can be mutated and then frozen once no more mutations are expected. This
15-
/// is useful for allowing the dictionary to be modified by a class's <c>init</c>
16-
/// properties, but then preventing it from being modified afterwards.</para>
14+
/// <para>It can be mutated and then frozen once no more mutations are expected.
15+
/// This is useful for allowing the dictionary to be modified by a class's
16+
/// <c>init</c> properties, but then preventing it from being modified afterwards.</para>
1717
///
1818
/// <para>It also caches data deserialization for performance.</para>
1919
/// </summary>

‎src/Orb/Core/MultipartJsonDictionary.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ namespace Orb.Core;
1111
/// <summary>
1212
/// A dictionary that holds mixed JSON and binary content.
1313
///
14-
/// <para>It can be mutated and then frozen once no more mutations are expected. This
15-
/// is useful for allowing the dictionary to be modified by a class's <c>init</c>
16-
/// properties, but then preventing it from being modified afterwards.</para>
14+
/// <para>It can be mutated and then frozen once no more mutations are expected.
15+
/// This is useful for allowing the dictionary to be modified by a class's
16+
/// <c>init</c> properties, but then preventing it from being modified afterwards.</para>
1717
///
1818
/// <para>It also caches data deserialization for performance.</para>
1919
/// </summary>

‎src/Orb/Models/AdjustmentInterval.cs‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ public Adjustment(JsonElement element)
254254
/// Returns true and sets the <c>out</c> parameter if the instance was constructed with a variant of
255255
/// type <see cref="PlanPhaseUsageDiscountAdjustment"/>.
256256
///
257-
/// <para>Consider using <see cref="Switch"> or <see cref="Match"> if you need to handle every variant.</para>
257+
/// <para>Consider using <see cref="Switch"/> or <see cref="Match"/> if you need to handle every variant.</para>
258258
///
259259
/// <example>
260260
/// <code>
@@ -277,7 +277,7 @@ public bool TryPickPlanPhaseUsageDiscount(
277277
/// Returns true and sets the <c>out</c> parameter if the instance was constructed with a variant of
278278
/// type <see cref="PlanPhaseAmountDiscountAdjustment"/>.
279279
///
280-
/// <para>Consider using <see cref="Switch"> or <see cref="Match"> if you need to handle every variant.</para>
280+
/// <para>Consider using <see cref="Switch"/> or <see cref="Match"/> if you need to handle every variant.</para>
281281
///
282282
/// <example>
283283
/// <code>
@@ -300,7 +300,7 @@ public bool TryPickPlanPhaseAmountDiscount(
300300
/// Returns true and sets the <c>out</c> parameter if the instance was constructed with a variant of
301301
/// type <see cref="PlanPhasePercentageDiscountAdjustment"/>.
302302
///
303-
/// <para>Consider using <see cref="Switch"> or <see cref="Match"> if you need to handle every variant.</para>
303+
/// <para>Consider using <see cref="Switch"/> or <see cref="Match"/> if you need to handle every variant.</para>
304304
///
305305
/// <example>
306306
/// <code>
@@ -323,7 +323,7 @@ public bool TryPickPlanPhasePercentageDiscount(
323323
/// Returns true and sets the <c>out</c> parameter if the instance was constructed with a variant of
324324
/// type <see cref="PlanPhaseMinimumAdjustment"/>.
325325
///
326-
/// <para>Consider using <see cref="Switch"> or <see cref="Match"> if you need to handle every variant.</para>
326+
/// <para>Consider using <see cref="Switch"/> or <see cref="Match"/> if you need to handle every variant.</para>
327327
///
328328
/// <example>
329329
/// <code>
@@ -344,7 +344,7 @@ public bool TryPickPlanPhaseMinimum([NotNullWhen(true)] out PlanPhaseMinimumAdju
344344
/// Returns true and sets the <c>out</c> parameter if the instance was constructed with a variant of
345345
/// type <see cref="PlanPhaseMaximumAdjustment"/>.
346346
///
347-
/// <para>Consider using <see cref="Switch"> or <see cref="Match"> if you need to handle every variant.</para>
347+
/// <para>Consider using <see cref="Switch"/> or <see cref="Match"/> if you need to handle every variant.</para>
348348
///
349349
/// <example>
350350
/// <code>
@@ -364,7 +364,7 @@ public bool TryPickPlanPhaseMaximum([NotNullWhen(true)] out PlanPhaseMaximumAdju
364364
/// <summary>
365365
/// Calls the function parameter corresponding to the variant the instance was constructed with.
366366
///
367-
/// <para>Use the <c>TryPick</c> method(s) if you don't need to handle every variant, or <see cref="Match">
367+
/// <para>Use the <c>TryPick</c> method(s) if you don't need to handle every variant, or <see cref="Match"/>
368368
/// if you need your function parameters to return something.</para>
369369
///
370370
/// <exception cref="OrbInvalidDataException">
@@ -375,11 +375,11 @@ public bool TryPickPlanPhaseMaximum([NotNullWhen(true)] out PlanPhaseMaximumAdju
375375
/// <example>
376376
/// <code>
377377
/// instance.Switch(
378-
/// (PlanPhaseUsageDiscountAdjustment value) => {...},
379-
/// (PlanPhaseAmountDiscountAdjustment value) => {...},
380-
/// (PlanPhasePercentageDiscountAdjustment value) => {...},
381-
/// (PlanPhaseMinimumAdjustment value) => {...},
382-
/// (PlanPhaseMaximumAdjustment value) => {...}
378+
/// (PlanPhaseUsageDiscountAdjustment value) =&gt; {...},
379+
/// (PlanPhaseAmountDiscountAdjustment value) =&gt; {...},
380+
/// (PlanPhasePercentageDiscountAdjustment value) =&gt; {...},
381+
/// (PlanPhaseMinimumAdjustment value) =&gt; {...},
382+
/// (PlanPhaseMaximumAdjustment value) =&gt; {...}
383383
/// );
384384
/// </code>
385385
/// </example>
@@ -418,7 +418,7 @@ public void Switch(
418418
/// Calls the function parameter corresponding to the variant the instance was constructed with and
419419
/// returns its result.
420420
///
421-
/// <para>Use the <c>TryPick</c> method(s) if you don't need to handle every variant, or <see cref="Switch">
421+
/// <para>Use the <c>TryPick</c> method(s) if you don't need to handle every variant, or <see cref="Switch"/>
422422
/// if you don't need your function parameters to return a value.</para>
423423
///
424424
/// <exception cref="OrbInvalidDataException">
@@ -429,11 +429,11 @@ public void Switch(
429429
/// <example>
430430
/// <code>
431431
/// var result = instance.Match(
432-
/// (PlanPhaseUsageDiscountAdjustment value) => {...},
433-
/// (PlanPhaseAmountDiscountAdjustment value) => {...},
434-
/// (PlanPhasePercentageDiscountAdjustment value) => {...},
435-
/// (PlanPhaseMinimumAdjustment value) => {...},
436-
/// (PlanPhaseMaximumAdjustment value) => {...}
432+
/// (PlanPhaseUsageDiscountAdjustment value) =&gt; {...},
433+
/// (PlanPhaseAmountDiscountAdjustment value) =&gt; {...},
434+
/// (PlanPhasePercentageDiscountAdjustment value) =&gt; {...},
435+
/// (PlanPhaseMinimumAdjustment value) =&gt; {...},
436+
/// (PlanPhaseMaximumAdjustment value) =&gt; {...}
437437
/// );
438438
/// </code>
439439
/// </example>

‎src/Orb/Models/Alerts/AlertCreateForCustomerParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ FrozenDictionary<string, JsonElement> rawBodyData
119119
}
120120
#pragma warning restore CS8618
121121

122-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
122+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
123123
public static AlertCreateForCustomerParams FromRawUnchecked(
124124
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
125125
IReadOnlyDictionary<string, JsonElement> rawQueryData,

‎src/Orb/Models/Alerts/AlertCreateForExternalCustomerParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ FrozenDictionary<string, JsonElement> rawBodyData
121121
}
122122
#pragma warning restore CS8618
123123

124-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
124+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
125125
public static AlertCreateForExternalCustomerParams FromRawUnchecked(
126126
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
127127
IReadOnlyDictionary<string, JsonElement> rawQueryData,

‎src/Orb/Models/Alerts/AlertCreateForSubscriptionParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ FrozenDictionary<string, JsonElement> rawBodyData
159159
}
160160
#pragma warning restore CS8618
161161

162-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
162+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
163163
public static AlertCreateForSubscriptionParams FromRawUnchecked(
164164
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
165165
IReadOnlyDictionary<string, JsonElement> rawQueryData,

‎src/Orb/Models/Alerts/AlertDisableParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ FrozenDictionary<string, JsonElement> rawQueryData
6666
}
6767
#pragma warning restore CS8618
6868

69-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
69+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
7070
public static AlertDisableParams FromRawUnchecked(
7171
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
7272
IReadOnlyDictionary<string, JsonElement> rawQueryData

‎src/Orb/Models/Alerts/AlertEnableParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ FrozenDictionary<string, JsonElement> rawQueryData
6666
}
6767
#pragma warning restore CS8618
6868

69-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
69+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
7070
public static AlertEnableParams FromRawUnchecked(
7171
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
7272
IReadOnlyDictionary<string, JsonElement> rawQueryData

‎src/Orb/Models/Alerts/AlertListParams.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ FrozenDictionary<string, JsonElement> rawQueryData
169169
}
170170
#pragma warning restore CS8618
171171

172-
/// <inheritdoc cref="IFromRawJson.FromRawUnchecked"/>
172+
/// <inheritdoc cref="IFromRawJson{T}.FromRawUnchecked"/>
173173
public static AlertListParams FromRawUnchecked(
174174
IReadOnlyDictionary<string, JsonElement> rawHeaderData,
175175
IReadOnlyDictionary<string, JsonElement> rawQueryData

0 commit comments

Comments
 (0)