Skip to content

Commit 659fc60

Browse files
committed
Fix ClipperBridge javadoc warnings
DEVSIX-4160
1 parent d4a4e3c commit 659fc60

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

kernel/src/main/java/com/itextpdf/kernel/pdf/canvas/parser/clipper/ClipperBridge.java

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ public class ClipperBridge {
7272
/**
7373
* Converts Clipper library {@link PolyTree} abstraction into iText
7474
* {@link com.itextpdf.kernel.geom.Path} object.
75+
*
76+
* @param result {@link PolyTree} object to convert
77+
* @return resultant {@link com.itextpdf.kernel.geom.Path} object
7578
*/
7679
public static com.itextpdf.kernel.geom.Path convertToPath(PolyTree result) {
7780
com.itextpdf.kernel.geom.Path path = new com.itextpdf.kernel.geom.Path();
@@ -104,6 +107,13 @@ public static void addPath(IClipper clipper, com.itextpdf.kernel.geom.Path path,
104107
* Adds all iText {@link Subpath}s of the iText {@link com.itextpdf.kernel.geom.Path} to the {@link ClipperOffset} object with one
105108
* note: it doesn't add degenerate subpaths.
106109
*
110+
* @param offset the {@link ClipperOffset} object to add all iText {@link Subpath}s that are not degenerated.
111+
* @param path {@link com.itextpdf.kernel.geom.Path} object, containing the required {@link Subpath}s
112+
* @param joinType {@link IClipper} join type. The value could be {@link IClipper.JoinType#BEVEL}, {@link IClipper.JoinType#ROUND},
113+
* {@link IClipper.JoinType#MITER}
114+
* @param endType {@link IClipper} end type. The value could be {@link IClipper.EndType#CLOSED_POLYGON},
115+
* {@link IClipper.EndType#CLOSED_LINE}, {@link IClipper.EndType#OPEN_BUTT}, {@link IClipper.EndType#OPEN_SQUARE},
116+
* {@link IClipper.EndType#OPEN_ROUND}
107117
* @return {@link java.util.List} consisting of all degenerate iText {@link Subpath}s of the path.
108118
*/
109119
public static List<Subpath> addPath(ClipperOffset offset, com.itextpdf.kernel.geom.Path path, IClipper.JoinType joinType, IClipper.EndType endType) {
@@ -136,6 +146,9 @@ public static List<Subpath> addPath(ClipperOffset offset, com.itextpdf.kernel.ge
136146
/**
137147
* Converts list of {@link Point.LongPoint} objects into list of
138148
* {@link com.itextpdf.kernel.geom.Point} objects.
149+
*
150+
* @param points the list of {@link Point.LongPoint} objects to convert
151+
* @return the resultant list of {@link com.itextpdf.kernel.geom.Point} objects.
139152
*/
140153
public static List<com.itextpdf.kernel.geom.Point> convertToFloatPoints(List<Point.LongPoint> points) {
141154
List<com.itextpdf.kernel.geom.Point> convertedPoints = new ArrayList<>(points.size());
@@ -153,6 +166,9 @@ public static List<com.itextpdf.kernel.geom.Point> convertToFloatPoints(List<Poi
153166
/**
154167
* Converts list of {@link com.itextpdf.kernel.geom.Point} objects into list of
155168
* {@link Point.LongPoint} objects.
169+
*
170+
* @param points the list of {@link com.itextpdf.kernel.geom.Point} objects to convert
171+
* @return the resultant list of {@link Point.LongPoint} objects.
156172
*/
157173
public static List<Point.LongPoint> convertToLongPoints(List<com.itextpdf.kernel.geom.Point> points) {
158174
List<Point.LongPoint> convertedPoints = new ArrayList<>(points.size());
@@ -276,6 +292,14 @@ static void addContour(com.itextpdf.kernel.geom.Path path, List<Point.LongPoint>
276292
}
277293

278294
/**
295+
* Adds rectangle path based on array of {@link com.itextpdf.kernel.geom.Point} (internally converting
296+
* them by {@link #convertToLongPoints}) and adds this path to {@link IClipper} instance.
297+
*
298+
* @param clipper {@link IClipper} instance to which the created rectangle path will be added.
299+
* @param rectVertices an array of {@link com.itextpdf.kernel.geom.Point} which will be internally converted
300+
* to clipper path and added to the clipper instance.
301+
* @param polyType either {@link IClipper.PolyType#SUBJECT} or {@link IClipper.PolyType#CLIP} denoting whether added
302+
* path is a subject of clipping or a part of the clipping polygon.
279303
* @deprecated use {@link #addPolygonToClipper} instead.
280304
*/
281305
@Deprecated

0 commit comments

Comments
 (0)