Skip to content

Commit 9d18277

Browse files
bradwilsonbradwilson
committed
chore: Use <see langword> instead of <c> for language keywords
1 parent 55b6055 commit 9d18277

6 files changed

Lines changed: 54 additions & 54 deletions

File tree

‎src/Hyphen.Sdk/Abstractions/IEnv.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ public interface IEnv
1212
/// Gets a <see cref="bool"/> value from the given environment variable.
1313
/// </summary>
1414
/// <param name="name">The environment variable name</param>
15-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
16-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
15+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
16+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
1717
/// <returns>The value</returns>
1818
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
1919
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -33,8 +33,8 @@ public interface IEnv
3333
/// <param name="name">The environment variable name</param>
3434
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
3535
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
36-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
37-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
36+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
37+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
3838
/// <returns>The value</returns>
3939
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
4040
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -46,8 +46,8 @@ public interface IEnv
4646
/// <param name="name">The environment variable name</param>
4747
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
4848
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
49-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
50-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
49+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
50+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
5151
/// <returns>The value</returns>
5252
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
5353
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -59,8 +59,8 @@ public interface IEnv
5959
/// <param name="name">The environment variable name</param>
6060
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
6161
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
62-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
63-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
62+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
63+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
6464
/// <returns>The value</returns>
6565
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
6666
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -72,8 +72,8 @@ public interface IEnv
7272
/// <param name="name">The environment variable name</param>
7373
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
7474
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
75-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
76-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
75+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
76+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
7777
/// <returns>The value</returns>
7878
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
7979
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -83,8 +83,8 @@ public interface IEnv
8383
/// Gets a <see cref="string"/> value from the given environment variable.
8484
/// </summary>
8585
/// <param name="name">The environment variable name</param>
86-
/// <param name="required">When <c>true</c> and the variable does not exist, will throw;
87-
/// when <c>false</c>, will return <c>null</c> instead.</param>
86+
/// <param name="required">When <see langword="true"/> and the variable does not exist, will throw;
87+
/// when <see langword="false"/>, will return <see langword="null"/> instead.</param>
8888
/// <returns>The value</returns>
8989
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
9090
/// and the variable does not exist (or is in the wrong format).</exception>

‎src/Hyphen.Sdk/Abstractions/ILink.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public interface ILink
5555
/// <param name="shortCodeId">The short code ID. (Example: <c>"code_686bed403c3991bd676bba4d"</c>)</param>
5656
/// <param name="qrCodeId">The QR code ID. (Example: <c>"lqr_66fc51fe144cf3a1bd2a35b1"</c>)</param>
5757
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
58-
/// <returns>Returns the QR code, if present; returns <c>null</c> for an unknown short code ID
58+
/// <returns>Returns the QR code, if present; returns <see langword="null"/> for an unknown short code ID
5959
/// or QR code ID or organization ID.</returns>
6060
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
6161
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
@@ -67,7 +67,7 @@ public interface ILink
6767
/// <param name="shortCodeId">The short code ID. (Example: <c>"code_686bed403c3991bd676bba4d"</c>)</param>
6868
/// <param name="parms">Optional parameters for getting the list of QR codes.</param>
6969
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
70-
/// <returns>The list of QR codes that match the search options; returns <c>null</c> for an unknown
70+
/// <returns>The list of QR codes that match the search options; returns <see langword="null"/> for an unknown
7171
/// short code ID or organization ID.</returns>
7272
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
7373
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
@@ -78,7 +78,7 @@ public interface ILink
7878
/// </summary>
7979
/// <param name="shortCodeId">The short code ID. (Example: <c>"code_686bed403c3991bd676bba4d"</c>)</param>
8080
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
81-
/// <returns>Returns the short code, if available; returns <c>null</c> for an unknown code or organization ID.</returns>
81+
/// <returns>Returns the short code, if available; returns <see langword="null"/> for an unknown code or organization ID.</returns>
8282
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
8383
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
8484
Task<ShortCodeResult?> GetShortCode(string shortCodeId, CancellationToken cancellationToken);
@@ -88,7 +88,7 @@ public interface ILink
8888
/// </summary>
8989
/// <param name="parms">Optional parameters for getting the list of short codes.</param>
9090
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
91-
/// <returns>The list of short codes that match the search options; returns <c>null</c> for an unknown organization ID.</returns>
91+
/// <returns>The list of short codes that match the search options; returns <see langword="null"/> for an unknown organization ID.</returns>
9292
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
9393
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
9494
Task<PagedResult<ShortCodeResult>?> GetShortCodes(GetShortCodesParams? parms, CancellationToken cancellationToken);
@@ -100,7 +100,7 @@ public interface ILink
100100
/// <param name="startDate">The start date.</param>
101101
/// <param name="endDate">The end date.</param>
102102
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
103-
/// <returns>The statistics for the given short code, if present; returns <c>null</c>
103+
/// <returns>The statistics for the given short code, if present; returns <see langword="null"/>
104104
/// for an unknown short code ID or organization ID.</returns>
105105
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
106106
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
@@ -110,7 +110,7 @@ public interface ILink
110110
/// Gets a list of all the tags used by the organization's short codes.
111111
/// </summary>
112112
/// <param name="cancellationToken">The cancellation token to cancel the request early</param>
113-
/// <returns>The combined list of tags, if present; returns <c>null</c> for an unknown organization ID.</returns>
113+
/// <returns>The combined list of tags, if present; returns <see langword="null"/> for an unknown organization ID.</returns>
114114
/// <exception cref="ApiKeyException">Thrown if the API key is not valid.</exception>
115115
/// <exception cref="HttpStatusCodeException">Thrown if the API returned an unexpected status code.</exception>
116116
Task<string[]?> GetTags(CancellationToken cancellationToken);

‎src/Hyphen.Sdk/Extensions/HyphenSdkEnvExtensions.cs‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ public static class HyphenSdkEnvExtensions
3232
/// </summary>
3333
/// <param name="env"/>
3434
/// <param name="name">The environment variable name</param>
35-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
36-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
35+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
36+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
3737
/// <returns>The value</returns>
3838
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
3939
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -56,8 +56,8 @@ public static class HyphenSdkEnvExtensions
5656
/// <param name="env"/>
5757
/// <param name="name">The environment variable name</param>
5858
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
59-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
60-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
59+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
60+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
6161
/// <returns>The value</returns>
6262
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
6363
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -80,8 +80,8 @@ public static class HyphenSdkEnvExtensions
8080
/// <param name="env"/>
8181
/// <param name="name">The environment variable name</param>
8282
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
83-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
84-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
83+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
84+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
8585
/// <returns>The value</returns>
8686
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
8787
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -102,8 +102,8 @@ public static class HyphenSdkEnvExtensions
102102
/// </summary>
103103
/// <param name="env"/>
104104
/// <param name="name">The environment variable name</param>
105-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
106-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
105+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
106+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
107107
/// <returns>The value</returns>
108108
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
109109
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -126,8 +126,8 @@ public static class HyphenSdkEnvExtensions
126126
/// <param name="env"/>
127127
/// <param name="name">The environment variable name</param>
128128
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
129-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
130-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
129+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
130+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
131131
/// <returns>The value</returns>
132132
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
133133
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -150,8 +150,8 @@ public static class HyphenSdkEnvExtensions
150150
/// <param name="env"/>
151151
/// <param name="name">The environment variable name</param>
152152
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
153-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
154-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
153+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
154+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
155155
/// <returns>The value</returns>
156156
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
157157
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -172,8 +172,8 @@ public static class HyphenSdkEnvExtensions
172172
/// </summary>
173173
/// <param name="env"/>
174174
/// <param name="name">The environment variable name</param>
175-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
176-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
175+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
176+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
177177
/// <returns>The value</returns>
178178
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
179179
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -196,8 +196,8 @@ public static class HyphenSdkEnvExtensions
196196
/// <param name="env"/>
197197
/// <param name="name">The environment variable name</param>
198198
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
199-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
200-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
199+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
200+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
201201
/// <returns>The value</returns>
202202
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
203203
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -220,8 +220,8 @@ public static class HyphenSdkEnvExtensions
220220
/// <param name="env"/>
221221
/// <param name="name">The environment variable name</param>
222222
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
223-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
224-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
223+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
224+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
225225
/// <returns>The value</returns>
226226
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
227227
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -242,8 +242,8 @@ public static class HyphenSdkEnvExtensions
242242
/// </summary>
243243
/// <param name="env"/>
244244
/// <param name="name">The environment variable name</param>
245-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
246-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
245+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
246+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
247247
/// <returns>The value</returns>
248248
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
249249
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -266,8 +266,8 @@ public static class HyphenSdkEnvExtensions
266266
/// <param name="env"/>
267267
/// <param name="name">The environment variable name</param>
268268
/// <param name="formatProvider">An object that supplies culture-specific parsing information.</param>
269-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
270-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
269+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
270+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
271271
/// <returns>The value</returns>
272272
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
273273
/// and the variable does not exist (or is in the wrong format).</exception>
@@ -290,8 +290,8 @@ public static class HyphenSdkEnvExtensions
290290
/// <param name="env"/>
291291
/// <param name="name">The environment variable name</param>
292292
/// <param name="numberStyles">A bitwise combination of enumeration values that indicates the permitted format.</param>
293-
/// <param name="required">When <c>true</c> and the variable does not exist (or is in the wrong
294-
/// format), will throw; when <c>false</c>, will return <c>null</c> instead.</param>
293+
/// <param name="required">When <see langword="true"/> and the variable does not exist (or is in the wrong
294+
/// format), will throw; when <see langword="false"/>, will return <see langword="null"/> instead.</param>
295295
/// <returns>The value</returns>
296296
/// <exception cref="InvalidOperationException">Thrown when <paramref name="required"/> is true
297297
/// and the variable does not exist (or is in the wrong format).</exception>

0 commit comments

Comments
 (0)