Fix javadoc warnings in sign module

DEVSIX-5133

Autoported commit.
Original commit hash: [e5a5dfd26]

Author: nikitakovaliov92

itext/itext.sign/itext/signatures/PdfPKCS7.cs

@@ -494,7 +494,12 @@ public virtual int GetSigningInfoVersion() {
 
         private PdfName filterSubtype;
 
-        /// <summary>Getter for the ID of the digest algorithm, e.g. "2.16.840.1.101.3.4.2.1"</summary>
+        /// <summary>Getter for the ID of the digest algorithm, e.g. "2.16.840.1.101.3.4.2.1".</summary>
+        /// <remarks>
+        /// Getter for the ID of the digest algorithm, e.g. "2.16.840.1.101.3.4.2.1".
+        /// See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000
+        /// </remarks>
+        /// <returns>the ID of the digest algorithm</returns>
         public virtual String GetDigestAlgorithmOid() {
             return digestAlgorithmOid;
         }
@@ -509,12 +514,21 @@ public virtual String GetHashAlgorithm() {
         /// <summary>The encryption algorithm.</summary>
         private String digestEncryptionAlgorithmOid;
 
-        /// <summary>Getter for the digest encryption algorithm</summary>
+        /// <summary>Getter for the digest encryption algorithm.</summary>
+        /// <remarks>
+        /// Getter for the digest encryption algorithm.
+        /// See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000
+        /// </remarks>
+        /// <returns>the encryption algorithm</returns>
         public virtual String GetDigestEncryptionAlgorithmOid() {
             return digestEncryptionAlgorithmOid;
         }
 
         /// <summary>Get the algorithm used to calculate the message digest, e.g. "SHA1withRSA".</summary>
+        /// <remarks>
+        /// Get the algorithm used to calculate the message digest, e.g. "SHA1withRSA".
+        /// See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000
+        /// </remarks>
         /// <returns>the algorithm used to calculate the message digest</returns>
         public virtual String GetDigestAlgorithm() {
             return GetHashAlgorithm() + "with" + GetEncryptionAlgorithm();
@@ -835,7 +849,6 @@ private Asn1EncodableVector BuildUnauthenticatedAttributes(byte[] timeStampToken
         /// <see cref="GetEncodedPKCS7(byte[])"/>.
         /// <para />
         /// A simple example:
-        /// <para />
         /// <pre>
         /// Calendar cal = Calendar.getInstance();
         /// PdfPKCS7 pk7 = new PdfPKCS7(key, chain, null, "SHA1", null, false);
@@ -877,7 +890,6 @@ public virtual byte[] GetAuthenticatedAttributeBytes(byte[] secondDigest, byte[]
         /// <see cref="GetEncodedPKCS7(byte[])"/>.
         /// <para />
         /// A simple example:
-        /// <para />
         /// <pre>
         /// Calendar cal = Calendar.getInstance();
         /// PdfPKCS7 pk7 = new PdfPKCS7(key, chain, null, "SHA1", null, false);
@@ -1306,7 +1318,8 @@ public virtual DateTime GetTimeStampDate() {
             return SignUtils.GetTimeStampDate(timeStampToken);
         }
 
-        /// <summary>Returns the filter subtype.</summary>
+        /// <summary>Getter for the filter subtype.</summary>
+        /// <returns>the filter subtype</returns>
         public virtual PdfName GetFilterSubtype() {
             return filterSubtype;
         }

itext/itext.sign/itext/signatures/PdfSignature.cs

@@ -142,6 +142,11 @@ public virtual void SetContents(byte[] contents) {
         }
 
         /// <summary>Gets the /Contents entry value.</summary>
+        /// <remarks>
+        /// Gets the /Contents entry value.
+        /// See ISO 32000-1 12.8.1, Table 252 – Entries in a signature dictionary.
+        /// </remarks>
+        /// <returns>the signature content</returns>
         public virtual PdfString GetContents() {
             return GetPdfObject().GetAsString(PdfName.Contents);
         }
@@ -153,6 +158,11 @@ public virtual void SetCert(byte[] cert) {
         }
 
         /// <summary>Gets the /Cert entry value of this signature.</summary>
+        /// <remarks>
+        /// Gets the /Cert entry value of this signature.
+        /// See ISO 32000-1 12.8.1, Table 252 – Entries in a signature dictionary.
+        /// </remarks>
+        /// <returns>the signature cert</returns>
         public virtual PdfString GetCert() {
             return GetPdfObject().GetAsString(PdfName.Cert);
         }

itext/itext.sign/itext/signatures/PdfSignatureAppearance.cs

@@ -479,8 +479,8 @@ public virtual bool IsInvisible() {
 
         /// <summary>Constructs appearance (top-level) for a signature.</summary>
         /// <returns>a top-level signature appearance</returns>
-        /// <seealso><a href="https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/ppkappearances.pdf">
-        /// *      Adobe Pdf Digital Signature Appearances</a> for further details</seealso>
+        /// <seealso><a href="https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/ppkappearances.pdf">Adobe Pdf Digital
+        /// * Signature Appearances</a></seealso>
         protected internal virtual PdfFormXObject GetAppearance() {
             PdfCanvas canvas;
             if (IsInvisible()) {

itext/itext.sign/itext/signatures/SignaturePermissions.cs

@@ -62,19 +62,23 @@ public class FieldLock {
             /// <summary>An array of PdfString values with fieldnames</summary>
             internal PdfArray fields;
 
-            /// <summary>Creates a FieldLock instance</summary>
+            /// <summary>Creates a FieldLock instance.</summary>
+            /// <param name="action">indicates the set of fields that should be locked</param>
+            /// <param name="fields">an array of text strings containing field names</param>
             public FieldLock(SignaturePermissions _enclosing, PdfName action, PdfArray fields) {
                 this._enclosing = _enclosing;
                 this.action = action;
                 this.fields = fields;
             }
 
             /// <summary>Getter for the field lock action.</summary>
+            /// <returns>the action of field lock dictionary</returns>
             public virtual PdfName GetAction() {
                 return this.action;
             }
 
             /// <summary>Getter for the fields involved in the lock action.</summary>
+            /// <returns>the fields of field lock dictionary</returns>
             public virtual PdfArray GetFields() {
                 return this.fields;
             }
@@ -104,6 +108,8 @@ public override String ToString() {
         /// in a signature dictionary as well as some of the permissions
         /// defined by the signature.
         /// </summary>
+        /// <param name="sigDict">the signature dictionary</param>
+        /// <param name="previous">the signature permissions</param>
         public SignaturePermissions(PdfDictionary sigDict, SignaturePermissions previous) {
             if (previous != null) {
                 annotationsAllowed &= previous.IsAnnotationsAllowed();

port-hash

@@ -1 +1 @@
-91bea8fa7cbe39088fe8761c5eb979eb1c5947d2
+e5a5dfd2662b8205bfb22eed87f6720ea319d1a9