Document System.Security.Cryptography.Pkcs.SubjectIdentifier.MatchesCertificate (dotnet#2939)

carlossanlop · Ron Petrusha · commit 9ae564cc881b · 2019-08-07T19:11:56.000Z
* Document System.Security.Cryptography.Pkcs.SubjectIdentifier.MatchesCertificate

* suggestions by rpetrusha

Co-Authored-By: Ron Petrusha &lt;ronpet@microsoft.com&gt;

* single paragraph

* Update xml/System.Security.Cryptography.Pkcs/SubjectIdentifier.xml

* suggestion by krwq

* suggestion by krwq

Co-Authored-By: Krzysztof Wicher &lt;mordotymoja@gmail.com&gt;

* Fixed broken xrefs
diff --git a/xml/System.Security.Cryptography.Pkcs/SubjectIdentifier.xml b/xml/System.Security.Cryptography.Pkcs/SubjectIdentifier.xml
@@ -52,10 +52,19 @@
         <Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" Index="0" FrameworkAlternate="dotnet-plat-ext-3.0" />
       </Parameters>
       <Docs>
-        <param name="certificate">To be added.</param>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
-        <remarks>To be added.</remarks>
+        <param name="certificate">The certificate to match with the current subject identifier instance.</param>
+        <summary>Verifies if the specified certificate's subject identifier matches current subject identifier instance.</summary>
+        <returns><see langword="true" /> if the specified certificate's identifier matches the current subject identifier instance; otherwise, <see langword="false" />.</returns>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+
+If the current subject identifier instance is of type <xref:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber?displayProperty=nameWithType>, this method compares the current instance's X09 issuer serial number and issuer name with the specified certificate's issuer serial number and issuer name. If the current subject identifier instance is of type <xref:System.Security.Cryptography.Pkcs.SubjectIdentifierType.SubjectKeyIdentifier?displayProperty=nameWithType>, this method compares the current instance's subject key identifier with the specified certificate's subject key identifier.
+
+          ]]></format>
+        </remarks>
+        <exception cref="T:System.Security.Cryptography.CryptographicException">Invalid subject identifier type.</exception>
       </Docs>
     </Member>
     <Member MemberName="Type">
@@ -135,4 +144,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
