@@ -83,6 +83,11 @@ private void ResetStrategy() {
8383 /// <see cref="iText.Kernel.Pdf.PdfPage"/>
8484 /// to be processed
8585 /// </param>
86+ /// <returns>
87+ /// a List of
88+ /// <see cref="iText.PdfCleanup.PdfCleanUpLocation"/>
89+ /// objects
90+ /// </returns>
8691 public virtual IList < PdfCleanUpLocation > GetPdfCleanUpLocations ( PdfPage page ) {
8792 // get document
8893 PdfDocument doc = page . GetDocument ( ) ;
@@ -115,6 +120,11 @@ public virtual IList<PdfCleanUpLocation> GetPdfCleanUpLocations(PdfPage page) {
115120 /// <see cref="iText.Kernel.Pdf.PdfDocument"/>
116121 /// to be processed
117122 /// </param>
123+ /// <returns>
124+ /// a List of
125+ /// <see cref="iText.PdfCleanup.PdfCleanUpLocation"/>
126+ /// objects
127+ /// </returns>
118128 public virtual IList < PdfCleanUpLocation > GetPdfCleanUpLocations ( PdfDocument doc ) {
119129 PdfDocumentContentParser parser = new PdfDocumentContentParser ( doc ) ;
120130 IList < PdfCleanUpLocation > toClean = new List < PdfCleanUpLocation > ( ) ;
@@ -127,12 +137,12 @@ public virtual IList<PdfCleanUpLocation> GetPdfCleanUpLocations(PdfDocument doc)
127137 }
128138 ResetStrategy ( ) ;
129139 }
130- JavaCollectionsUtil . Sort ( toClean , new _IComparer_130 ( ) ) ;
140+ JavaCollectionsUtil . Sort ( toClean , new _IComparer_132 ( ) ) ;
131141 return toClean ;
132142 }
133143
134- private sealed class _IComparer_130 : IComparer < PdfCleanUpLocation > {
135- public _IComparer_130 ( ) {
144+ private sealed class _IComparer_132 : IComparer < PdfCleanUpLocation > {
145+ public _IComparer_132 ( ) {
136146 }
137147
138148 public int Compare ( PdfCleanUpLocation o1 , PdfCleanUpLocation o2 ) {
@@ -193,7 +203,10 @@ public virtual void Highlight(PdfPage pdfPage) {
193203 /// <see cref="iText.Kernel.Pdf.PdfDocument"/>
194204 /// to be redacted
195205 /// </param>
196- /// <exception cref="System.IO.IOException"/>
206+ /// <exception cref="System.IO.IOException">
207+ /// an
208+ /// <see cref="System.IO.IOException"/>
209+ /// </exception>
197210 public virtual void CleanUp ( PdfDocument pdfDocument ) {
198211 IList < PdfCleanUpLocation > cleanUpLocations = GetPdfCleanUpLocations ( pdfDocument ) ;
199212 PdfCleanUpTool cleaner = ( cleanUpLocations == null ) ? new PdfCleanUpTool ( pdfDocument , true ) : new PdfCleanUpTool
@@ -210,7 +223,10 @@ public virtual void CleanUp(PdfDocument pdfDocument) {
210223 /// <see cref="iText.Kernel.Pdf.PdfPage"/>
211224 /// to be redacted
212225 /// </param>
213- /// <exception cref="System.IO.IOException"/>
226+ /// <exception cref="System.IO.IOException">
227+ /// an
228+ /// <see cref="System.IO.IOException"/>
229+ /// </exception>
214230 public virtual void CleanUp ( PdfPage pdfPage ) {
215231 IList < PdfCleanUpLocation > cleanUpLocations = GetPdfCleanUpLocations ( pdfPage ) ;
216232 PdfCleanUpTool cleaner = ( cleanUpLocations == null ) ? new PdfCleanUpTool ( pdfPage . GetDocument ( ) , true ) : new
@@ -224,7 +240,7 @@ public virtual void CleanUp(PdfPage pdfPage) {
224240 /// This method will add all redaction annotations to the given document, allowing
225241 /// the end-user to choose which redactions to keep or delete.
226242 /// </summary>
227- /// <param name="pdfDocument"/ >
243+ /// <param name="pdfDocument">the document to clean up</param >
228244 public virtual void TentativeCleanUp ( PdfDocument pdfDocument ) {
229245 for ( int i = 1 ; i <= pdfDocument . GetNumberOfPages ( ) ; i ++ ) {
230246 TentativeCleanUp ( pdfDocument . GetPage ( i ) ) ;
@@ -237,7 +253,7 @@ public virtual void TentativeCleanUp(PdfDocument pdfDocument) {
237253 /// This method will add all redaction annotations to the given page, allowing
238254 /// the end-user to choose which redactions to keep or delete.
239255 /// </summary>
240- /// <param name="pdfPage"/ >
256+ /// <param name="pdfPage">the page to clean up</param >
241257 public virtual void TentativeCleanUp ( PdfPage pdfPage ) {
242258 IList < PdfCleanUpLocation > cleanUpLocations = GetPdfCleanUpLocations ( pdfPage ) ;
243259 // random title generation
0 commit comments