Skip to content

Commit 40dfd55

Browse files
amedeepavel-alay
authored andcommitted
Fix javadoc warnings
Autoported commit. Original commit hash: [50949e6]
1 parent 2d30f2d commit 40dfd55

File tree

4 files changed

+30
-9
lines changed

4 files changed

+30
-9
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ public bool IsProcessAnnotations()
290290
/// Set if page annotations will be processed
291291
/// Default processing behaviour: remove annotation if there is overlap with a redaction region
292292
/// </summary>
293-
/// <param name="processAnnotations">If true annotations will be processed by the PdfCleanUpTool</param>
293+
/// <param name="processAnnotations">if page annotations will be processed</param>
294294
public void SetProcessAnnotations(bool processAnnotations)
295295
{
296296
this.processAnnotations = processAnnotations;

itext/itext.cleanup/itext/pdfcleanup/autosweep/ICleanupStrategy.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ namespace iText.PdfCleanup.Autosweep {
5151
/// </summary>
5252
public interface ICleanupStrategy : ILocationExtractionStrategy {
5353
/// <summary>Get the color in which redaction is to take place</summary>
54+
/// <param name="location">where to get the redaction color from</param>
55+
/// <returns>
56+
/// a
57+
/// <see cref="iText.Kernel.Colors.Color"/>
58+
/// </returns>
5459
Color GetRedactionColor(IPdfTextLocation location);
5560

5661
/// <summary>

itext/itext.cleanup/itext/pdfcleanup/autosweep/PdfAutoSweep.cs

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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

port-hash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
95413ad552660c34f67ce48f3e9335e28e425a7d
1+
50949e6037121d4fe1d12ef97a57f726d9188092

0 commit comments

Comments
 (0)