Fix javadocs warning

DEVSIX-5048

Autoported commit.
Original commit hash: [d647931aa]

Author: dzmitry.kachkou

itext/itext.sign/itext/signatures/OCSPVerifier.cs

@@ -74,9 +74,9 @@ public OCSPVerifier(CertificateVerifier verifier, IList<BasicOcspResp> ocsps)
             this.ocsps = ocsps;
         }
 
-        /// <summary>Verifies if a a valid OCSP response is found for the certificate.</summary>
+        /// <summary>Verifies if a valid OCSP response is found for the certificate.</summary>
         /// <remarks>
-        /// Verifies if a a valid OCSP response is found for the certificate.
+        /// Verifies if a valid OCSP response is found for the certificate.
         /// If this method returns false, it doesn't mean the certificate isn't valid.
         /// It means we couldn't verify it against any OCSP response that was available.
         /// </remarks>

itext/itext.sign/itext/signatures/OcspClientBouncyCastle.cs

@@ -78,6 +78,7 @@ public OcspClientBouncyCastle(OCSPVerifier verifier) {
         /// <param name="checkCert">to certificate to check</param>
         /// <param name="rootCert">the parent certificate</param>
         /// <param name="url">to get the verification</param>
+        /// <returns>OCSP response</returns>
         public virtual BasicOcspResp GetBasicOCSPResp(X509Certificate checkCert, X509Certificate rootCert, String 
             url) {
             try {

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

@@ -194,6 +194,7 @@ public virtual int GetPageNumber() {
         /// The page number of the signature field which
         /// this signature appearance is associated with.
         /// </param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetPageNumber(int pageNumber) {
             this.page = pageNumber;
             SetPageRect(pageRect);
@@ -220,6 +221,7 @@ public virtual Rectangle GetPageRect() {
         /// The rectangle that represents the position and
         /// dimension of the signature field in the page.
         /// </param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetPageRect(Rectangle pageRect) {
             this.pageRect = new Rectangle(pageRect);
             this.rect = new Rectangle(pageRect.GetWidth(), pageRect.GetHeight());
@@ -254,6 +256,7 @@ public virtual PdfSignatureAppearance.RenderingMode GetRenderingMode() {
 
         /// <summary>Sets the rendering mode for this signature.</summary>
         /// <param name="renderingMode">the rendering mode</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetRenderingMode(PdfSignatureAppearance.RenderingMode
              renderingMode) {
             this.renderingMode = renderingMode;
@@ -268,13 +271,15 @@ public virtual String GetReason() {
 
         /// <summary>Sets the signing reason.</summary>
         /// <param name="reason">signing reason.</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetReason(String reason) {
             this.reason = reason;
             return this;
         }
 
         /// <summary>Sets the caption for the signing reason.</summary>
         /// <param name="reasonCaption">A new signing reason caption</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetReasonCaption(String reasonCaption) {
             this.reasonCaption = reasonCaption;
             return this;
@@ -288,13 +293,15 @@ public virtual String GetLocation() {
 
         /// <summary>Sets the signing location.</summary>
         /// <param name="location">A new signing location</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLocation(String location) {
             this.location = location;
             return this;
         }
 
         /// <summary>Sets the caption for the signing location.</summary>
         /// <param name="locationCaption">A new signing location caption</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLocationCaption(String locationCaption) {
             this.locationCaption = locationCaption;
             return this;
@@ -308,6 +315,7 @@ public virtual String GetSignatureCreator() {
 
         /// <summary>Sets the name of the application used to create the signature.</summary>
         /// <param name="signatureCreator">A new name of the application signing a document</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetSignatureCreator(String signatureCreator) {
             this.signatureCreator = signatureCreator;
             return this;
@@ -321,6 +329,7 @@ public virtual String GetContact() {
 
         /// <summary>Sets the signing contact.</summary>
         /// <param name="contact">A new signing contact</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetContact(String contact) {
             this.contact = contact;
             return this;
@@ -332,6 +341,7 @@ public virtual iText.Signatures.PdfSignatureAppearance SetContact(String contact
         /// This certificate doesn't take part in the actual signing process.
         /// </remarks>
         /// <param name="signCertificate">the certificate</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetCertificate(X509Certificate signCertificate) {
             this.signCertificate = signCertificate;
             return this;
@@ -352,13 +362,15 @@ public virtual ImageData GetSignatureGraphic() {
         /// <summary>Sets the Image object to render when Render is set to RenderingMode.GRAPHIC or RenderingMode.GRAPHIC_AND_DESCRIPTION.
         ///     </summary>
         /// <param name="signatureGraphic">image rendered. If null the mode is defaulted to RenderingMode.DESCRIPTION</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetSignatureGraphic(ImageData signatureGraphic) {
             this.signatureGraphic = signatureGraphic;
             return this;
         }
 
         /// <summary>Indicates that the existing appearances needs to be reused as layer 0.</summary>
-        /// <param name="reuseAppearance"/>
+        /// <param name="reuseAppearance">is an appearances reusing flag value to set</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetReuseAppearance(bool reuseAppearance) {
             this.reuseAppearance = reuseAppearance;
             return this;
@@ -373,6 +385,7 @@ public virtual ImageData GetImage() {
 
         /// <summary>Sets the background image for the layer 2.</summary>
         /// <param name="image">the background image for the layer 2</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetImage(ImageData image) {
             this.image = image;
             return this;
@@ -392,6 +405,7 @@ public virtual float GetImageScale() {
         /// In any of the cases the image will always be centered. It's zero by default.
         /// </remarks>
         /// <param name="imageScale">the scaling to be applied to the background image</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetImageScale(float imageScale) {
             this.imageScale = imageScale;
             return this;
@@ -402,6 +416,7 @@ public virtual iText.Signatures.PdfSignatureAppearance SetImageScale(float image
         /// the signature text identifying the signer. If null or not set
         /// a standard description will be used
         /// </param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLayer2Text(String text) {
             layer2Text = text;
             return this;
@@ -422,13 +437,15 @@ public virtual PdfFont GetLayer2Font() {
         /// <summary>Sets the n2 and n4 layer font.</summary>
         /// <remarks>Sets the n2 and n4 layer font. If the font size is zero, auto-fit will be used.</remarks>
         /// <param name="layer2Font">the n2 and n4 font</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLayer2Font(PdfFont layer2Font) {
             this.layer2Font = layer2Font;
             return this;
         }
 
         /// <summary>Sets the n2 and n4 layer font size.</summary>
         /// <param name="fontSize">font size</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLayer2FontSize(float fontSize) {
             this.layer2FontSize = fontSize;
             return this;
@@ -442,6 +459,7 @@ public virtual float GetLayer2FontSize() {
 
         /// <summary>Sets the n2 and n4 layer font color.</summary>
         /// <param name="color">font color</param>
+        /// <returns>this instance to support fluent interface</returns>
         public virtual iText.Signatures.PdfSignatureAppearance SetLayer2FontColor(Color color) {
             this.layer2FontColor = color;
             return this;
@@ -460,9 +478,9 @@ public virtual bool IsInvisible() {
         }
 
         /// <summary>Constructs appearance (top-level) for a signature.</summary>
-        /// <seealso><a href="http://partners.adobe.com/asn/developer/pdfs/tn/ppkappearances.pdf">PPKAppearances.pdf</a> for further details
-        ///     </seealso>
         /// <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>
         protected internal virtual PdfFormXObject GetAppearance() {
             PdfCanvas canvas;
             if (IsInvisible()) {
@@ -688,13 +706,15 @@ protected internal virtual DateTime GetSignDate() {
 
         /// <summary>Sets the signature date.</summary>
         /// <param name="signDate">A new signature date</param>
+        /// <returns>this instance to support fluent interface</returns>
         protected internal virtual iText.Signatures.PdfSignatureAppearance SetSignDate(DateTime signDate) {
             this.signDate = signDate;
             return this;
         }
 
         /// <summary>Set the field name of the appearance.</summary>
         /// <param name="fieldName">name of the field</param>
+        /// <returns>this instance to support fluent interface</returns>
         protected internal virtual iText.Signatures.PdfSignatureAppearance SetFieldName(String fieldName) {
             this.fieldName = fieldName;
             return this;

itext/itext.sign/itext/signatures/TSAClientBouncyCastle.cs

@@ -117,10 +117,11 @@ public TSAClientBouncyCastle(String url, String username, String password)
         /// size is not likely to change (as long as we call the same TSA using
         /// the same imprint length).
         /// </remarks>
-        /// <param name="url">String - Time Stamp Authority URL (i.e. "http://tsatest1.digistamp.com/TSA")</param>
-        /// <param name="username">String - user(account) name</param>
-        /// <param name="password">String - password</param>
-        /// <param name="tokSzEstimate">int - estimated size of received time stamp token (DER encoded)</param>
+        /// <param name="url">Time Stamp Authority URL (i.e. "http://tsatest1.digistamp.com/TSA")</param>
+        /// <param name="username">user(account) name</param>
+        /// <param name="password">password</param>
+        /// <param name="tokSzEstimate">estimated size of received time stamp token (DER encoded)</param>
+        /// <param name="digestAlgorithm">is a hash algorithm</param>
         public TSAClientBouncyCastle(String url, String username, String password, int tokSzEstimate, String digestAlgorithm
             ) {
             this.tsaURL = url;
@@ -216,6 +217,7 @@ public virtual byte[] GetTimeStampToken(byte[] imprint) {
         }
 
         /// <summary>Get timestamp token - communications layer</summary>
+        /// <param name="requestBytes">is a byte representation of TSA request</param>
         /// <returns>- byte[] - TSA response, raw bytes (RFC 3161 encoded)</returns>
         protected internal virtual byte[] GetTSAResponse(byte[] requestBytes) {
             // Setup the TSA connection

itext/itext.sign/itext/signatures/VerificationException.cs

@@ -50,6 +50,8 @@ namespace iText.Signatures {
     /// <summary>An exception that is thrown when something is wrong with a certificate.</summary>
     public class VerificationException : GeneralSecurityException {
         /// <summary>Creates a VerificationException</summary>
+        /// <param name="cert">is a failed certificate</param>
+        /// <param name="message">is a reason of failure</param>
         public VerificationException(X509Certificate cert, String message)
             : base(MessageFormatUtil.Format("Certificate {0} failed: {1}", cert == null ? "Unknown" : ((X509Certificate
                 )cert).SubjectDN.ToString(), message)) {

port-hash

@@ -1 +1 @@
-a7e841cb148776a804ab87530a76cecc1632bc5e
+d647931aa9e55f67c09088e6cdb898c1b6dcb77b