Add missing javadocs

DEVSIX-6349

Autoported commit.
Original commit hash: [c46afb5]

Author: ars18wrw

itext/itext.cleanup/itext/pdfcleanup/PdfCleanUpEventListener.cs

@@ -48,6 +48,7 @@ source product.
 using iText.Kernel.Pdf.Canvas.Parser.Listener;
 
 namespace iText.PdfCleanup {
+    /// <summary>An event listener which handles cleanup related events.</summary>
     public class PdfCleanUpEventListener : IEventListener {
         private const String textDataExpected = "Text data expected.";
 
@@ -57,6 +58,7 @@ public class PdfCleanUpEventListener : IEventListener {
 
         private IList<IEventData> content = new List<IEventData>();
 
+        /// <summary><inheritDoc/></summary>
         public virtual void EventOccurred(IEventData data, EventType type) {
             switch (type) {
                 case EventType.RENDER_TEXT:
@@ -121,6 +123,7 @@ internal virtual PathRenderInfo GetEncounteredPath() {
             return (PathRenderInfo)eventData;
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual ICollection<EventType> GetSupportedEvents() {
             return null;
         }

itext/itext.cleanup/itext/pdfcleanup/PdfCleanUpProcessor.cs

@@ -64,6 +64,7 @@ source product.
 using iText.PdfCleanup.Util;
 
 namespace iText.PdfCleanup {
+    /// <summary>PDF content stream processor, which filters content to be cleaned up.</summary>
     public class PdfCleanUpProcessor : PdfCanvasProcessor {
         private static readonly ICollection<String> TEXT_SHOWING_OPERATORS = JavaCollectionsUtil.UnmodifiableSet(new 
             HashSet<String>(JavaUtil.ArraysAsList("TJ", "Tj", "'", "\"")));

itext/itext.cleanup/itext/pdfcleanup/PdfCleanUpTool.cs

@@ -197,6 +197,20 @@ public PdfCleanUpTool(PdfDocument pdfDocument, IList<iText.PdfCleanup.PdfCleanUp
             }
         }
 
+        /// <summary>
+        /// Adds a
+        /// <see cref="PdfCleanUpLocation"/>
+        /// to be cleaned up.
+        /// </summary>
+        /// <param name="cleanUpLocation">
+        /// a
+        /// <see cref="PdfCleanUpLocation"/>
+        /// to be cleaned up
+        /// </param>
+        /// <returns>
+        /// this
+        /// <see cref="PdfCleanUpTool"/>
+        /// </returns>
         public virtual iText.PdfCleanup.PdfCleanUpTool AddCleanupLocation(iText.PdfCleanup.PdfCleanUpLocation cleanUpLocation
             ) {
             IList<iText.PdfCleanup.PdfCleanUpLocation> pgLocations = this.pdfCleanUpLocations.Get(cleanUpLocation.GetPage

itext/itext.cleanup/itext/pdfcleanup/autosweep/CompositeCleanupStrategy.cs

@@ -51,22 +51,45 @@ source product.
 namespace iText.PdfCleanup.Autosweep {
     /// <summary>
     /// This class is a composite pattern for
-    /// <c>ICleanupStrategy</c>
-    /// It allows users to have multiple ICleanupStrategy implementations and bundle them as one.
+    /// <see cref="ICleanupStrategy"/>.
     /// </summary>
+    /// <remarks>
+    /// This class is a composite pattern for
+    /// <see cref="ICleanupStrategy"/>.
+    /// It allows users to have multiple ICleanupStrategy implementations and bundle them as one.
+    /// </remarks>
     public class CompositeCleanupStrategy : ICleanupStrategy {
         private IDictionary<int, ICollection<IPdfTextLocation>> locations = new Dictionary<int, ICollection<IPdfTextLocation
             >>();
 
         private IList<ICleanupStrategy> strategies = new List<ICleanupStrategy>();
 
+        /// <summary>
+        /// Creates a
+        /// <see cref="CompositeCleanupStrategy">composite pattern</see>
+        /// for
+        /// <see cref="ICleanupStrategy">cleanup strategies</see>.
+        /// </summary>
         public CompositeCleanupStrategy() {
         }
 
-        public virtual void Add(ICleanupStrategy ies) {
-            strategies.Add(ies);
+        /// <summary>
+        /// Adds a
+        /// <see cref="ICleanupStrategy">cleanup strategy</see>
+        /// to this
+        /// <see cref="CompositeCleanupStrategy">composite pattern</see>.
+        /// </summary>
+        /// <param name="strategy">
+        /// a
+        /// <see cref="ICleanupStrategy">cleanup strategy</see>
+        /// to be added to this
+        /// <see cref="CompositeCleanupStrategy">composite pattern</see>.
+        /// </param>
+        public virtual void Add(ICleanupStrategy strategy) {
+            strategies.Add(strategy);
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual ICollection<IPdfTextLocation> GetResultantLocations() {
             locations.Clear();
             // build return value
@@ -78,13 +101,12 @@ public virtual ICollection<IPdfTextLocation> GetResultantLocations() {
                 locations.Put(i, new HashSet<IPdfTextLocation>(rects));
             }
             IList<IPdfTextLocation> rectangles = new List<IPdfTextLocation>(retval);
-            JavaCollectionsUtil.Sort(rectangles, new _IComparer_94());
-            // return
+            JavaCollectionsUtil.Sort(rectangles, new _IComparer_106());
             return rectangles;
         }
 
-        private sealed class _IComparer_94 : IComparer<IPdfTextLocation> {
-            public _IComparer_94() {
+        private sealed class _IComparer_106 : IComparer<IPdfTextLocation> {
+            public _IComparer_106() {
             }
 
             public int Compare(IPdfTextLocation l1, IPdfTextLocation l2) {
@@ -99,6 +121,7 @@ public int Compare(IPdfTextLocation l1, IPdfTextLocation l2) {
             }
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual Color GetRedactionColor(IPdfTextLocation location) {
             for (int i = 0; i < strategies.Count; i++) {
                 if (locations.Get(i).Contains(location)) {
@@ -108,12 +131,14 @@ public virtual Color GetRedactionColor(IPdfTextLocation location) {
             return ColorConstants.BLACK;
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual void EventOccurred(IEventData data, EventType type) {
             foreach (ILocationExtractionStrategy s in strategies) {
                 s.EventOccurred(data, type);
             }
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual ICollection<EventType> GetSupportedEvents() {
             ICollection<EventType> evts = new HashSet<EventType>();
             foreach (ILocationExtractionStrategy s in strategies) {
@@ -125,13 +150,35 @@ public virtual ICollection<EventType> GetSupportedEvents() {
             return evts.IsEmpty() ? null : evts;
         }
 
+        /// <summary>
+        /// Returns a
+        /// <see cref="ICleanupStrategy">cleanup strategy</see>
+        /// which represents
+        /// a reset
+        /// <see cref="CompositeCleanupStrategy">composite cleanup strategy</see>.
+        /// </summary>
+        /// <remarks>
+        /// Returns a
+        /// <see cref="ICleanupStrategy">cleanup strategy</see>
+        /// which represents
+        /// a reset
+        /// <see cref="CompositeCleanupStrategy">composite cleanup strategy</see>.
+        /// <para />
+        /// Note that all the inner
+        /// <see cref="ICleanupStrategy">strategies</see>
+        /// will be reset as well.
+        /// </remarks>
+        /// <returns>
+        /// a reset
+        /// <see cref="CompositeCleanupStrategy">composite strategy</see>
+        /// </returns>
         public virtual ICleanupStrategy Reset() {
-            iText.PdfCleanup.Autosweep.CompositeCleanupStrategy retval = new iText.PdfCleanup.Autosweep.CompositeCleanupStrategy
+            iText.PdfCleanup.Autosweep.CompositeCleanupStrategy resetCompositeStrategy = new iText.PdfCleanup.Autosweep.CompositeCleanupStrategy
                 ();
             foreach (ICleanupStrategy s in strategies) {
-                retval.Add(s.Reset());
+                resetCompositeStrategy.Add(s.Reset());
             }
-            return retval;
+            return resetCompositeStrategy;
         }
     }
 }

itext/itext.cleanup/itext/pdfcleanup/autosweep/RegexBasedCleanupStrategy.cs

@@ -52,25 +52,49 @@ public class RegexBasedCleanupStrategy : RegexBasedLocationExtractionStrategy, I
 
         private Color redactionColor = ColorConstants.BLACK;
 
+        /// <summary>Creates an object of regular expression based cleanup strategy.</summary>
+        /// <param name="regex">regular expression on which cleanup strategy will be based</param>
         public RegexBasedCleanupStrategy(String regex)
             : base(regex) {
             this.pattern = iText.Commons.Utils.StringUtil.RegexCompile(regex);
         }
 
+        /// <summary>Creates an object of regular expression based cleanup strategy.</summary>
+        /// <param name="pattern">
+        /// 
+        /// <see cref="System.Text.RegularExpressions.Regex"/>
+        /// pattern on which cleanup strategy will be based
+        /// </param>
         public RegexBasedCleanupStrategy(Regex pattern)
             : base(pattern) {
             this.pattern = pattern;
         }
 
+        /// <summary><inheritDoc/></summary>
         public virtual Color GetRedactionColor(IPdfTextLocation location) {
             return redactionColor;
         }
 
+        /// <summary>Sets the color in which redaction is to take place.</summary>
+        /// <param name="color">the color in which redaction is to take place</param>
+        /// <returns>
+        /// this
+        /// <see cref="RegexBasedCleanupStrategy">strategy</see>
+        /// </returns>
         public virtual iText.PdfCleanup.Autosweep.RegexBasedCleanupStrategy SetRedactionColor(Color color) {
             this.redactionColor = color;
             return this;
         }
 
+        /// <summary>
+        /// Returns an
+        /// <see cref="ICleanupStrategy"/>
+        /// object which is set to this regular pattern and redaction color.
+        /// </summary>
+        /// <returns>
+        /// a reset
+        /// <see cref="ICleanupStrategy">cleanup strategy</see>
+        /// </returns>
         public virtual ICleanupStrategy Reset() {
             return new iText.PdfCleanup.Autosweep.RegexBasedCleanupStrategy(pattern).SetRedactionColor(redactionColor);
         }

itext/itext.cleanup/itext/pdfcleanup/logs/CleanUpLogMessageConstant.cs

@@ -23,6 +23,7 @@ You should have received a copy of the GNU Affero General Public License
 using System;
 
 namespace iText.PdfCleanup.Logs {
+    /// <summary>Class that bundles all the log message templates as constants.</summary>
     public class CleanUpLogMessageConstant {
         /// <summary>The Constant CANNOT_OBTAIN_IMAGE_INFO_AFTER_FILTERING.</summary>
         public const String CANNOT_OBTAIN_IMAGE_INFO_AFTER_FILTERING = "Cannot obtain image info after filtering.";

port-hash

@@ -1 +1 @@
-fc4787cb9ce8c1d8720cb01dfb36c2423afa7de9
+c46afb540b875a2340e3c1ce352efb7ec075c65f