Skip to content

Commit 052dc0e

Browse files
carlossanlopRon Petrusha
authored andcommitted
Port System.Security.Claims source comments to Docs (#2307)
* Ported System.Security.Claims source code triple slash comments to dotnet-api-docs * Apply suggestions from code review Suggestions from rpetrusha Co-Authored-By: carlossanlop <[email protected]>
1 parent e4f3122 commit 052dc0e

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

xml/System.Security.Claims/Claim.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ if (null != principal)
165165
<param name="other">The security claim.</param>
166166
<summary>Initializes a new instance of the <see cref="T:System.Security.Claims.Claim" /> class.</summary>
167167
<remarks></remarks>
168+
<exception cref="T:System.ArgumentNullException"><paramref name="other" /> is <see langword="null" />.</exception>
168169
</Docs>
169170
</Member>
170171
<Member MemberName=".ctor">
@@ -201,6 +202,7 @@ if (null != principal)
201202
<param name="subject">The subject that this claim describes.</param>
202203
<summary>Initializes a new instance of the <see cref="T:System.Security.Claims.Claim" /> class with the specified reader and subject.</summary>
203204
<remarks></remarks>
205+
<exception cref="T:System.ArgumentNullException"><paramref name="reader" /> is <see langword="null" />.</exception>
204206
</Docs>
205207
</Member>
206208
<Member MemberName=".ctor">
@@ -237,6 +239,7 @@ if (null != principal)
237239
<param name="subject">The subject that this claim describes.</param>
238240
<summary>Initializes a new instance of the <see cref="T:System.Security.Claims.Claim" /> class with the specified security claim and subject.</summary>
239241
<remarks></remarks>
242+
<exception cref="T:System.ArgumentNullException"><paramref name="other" /> is <see langword="null" />.</exception>
240243
</Docs>
241244
</Member>
242245
<Member MemberName=".ctor">
@@ -1044,7 +1047,8 @@ if (null != principal)
10441047
<param name="userData">The user data to claim.</param>
10451048
<summary>Writes this <see cref="T:System.Security.Claims.Claim" /> to the writer.</summary>
10461049
<remarks></remarks>
1050+
<exception cref="T:System.ArgumentNullException"><paramref name="writer" /> is <see langword="null" />.</exception>
10471051
</Docs>
10481052
</Member>
10491053
</Members>
1050-
</Type>
1054+
</Type>

xml/System.Security.Claims/ClaimsIdentity.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@
258258
<summary>Initializes a new instance of the <see cref="T:System.Security.Claims.ClaimsIdentity" /> class from a serialized stream created by using <see cref="T:System.Runtime.Serialization.ISerializable" />.</summary>
259259
<remarks></remarks>
260260
<permission cref="T:System.Security.SecurityCriticalAttribute">requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
261+
<exception cref="T:System.ArgumentNullException"><paramref name="info" /> is <see langword="null" />.</exception>
261262
</Docs>
262263
</Member>
263264
<Member MemberName=".ctor">
@@ -747,6 +748,7 @@
747748
748749
]]></format>
749750
</remarks>
751+
<exception cref="T:System.InvalidOperationException"><paramref name="identity" /> is a <see cref="T:System.Security.Claims.ClaimsIdentity" /> and <see cref="P:System.Security.Claims.ClaimsIdentity.Actor" /> results in a circular reference back to <see langword="this" />.</exception>
750752
</Docs>
751753
</Member>
752754
<Member MemberName="Actor">
@@ -1994,4 +1996,4 @@
19941996
</Docs>
19951997
</Member>
19961998
</Members>
1997-
</Type>
1999+
</Type>

xml/System.Security.Claims/ClaimsPrincipal.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,7 @@ if (null != principal)
627627
<summary>Creates a new claims identity.</summary>
628628
<returns>The created claims identity.</returns>
629629
<remarks></remarks>
630+
<exception cref="T:System.ArgumentNullException"><paramref name="reader" /> is <see langword="null" />.</exception>
630631
</Docs>
631632
</Member>
632633
<Member MemberName="Current">
@@ -1320,4 +1321,4 @@ if (null != principal)
13201321
</Docs>
13211322
</Member>
13221323
</Members>
1323-
</Type>
1324+
</Type>

0 commit comments

Comments
 (0)