Add missing documentation to several layout classes

ars18wrw · ars18wrw · commit 22b28c21a6e4 · 2022-05-10T08:25:56.000Z
DEVSIX-6640
diff --git a/layout/src/main/java/com/itextpdf/layout/borders/Border.java b/layout/src/main/java/com/itextpdf/layout/borders/Border.java
@@ -445,6 +445,15 @@ public enum Side {
         NONE, TOP, RIGHT, BOTTOM, LEFT
     }
 
+    /**
+     * Gets a {@link Point} in which two lines intersect.
+     *
+     * @param lineBeg a {@link Point} which defines some point on the first line
+     * @param lineEnd a {@link Point} which defines another point on the first line
+     * @param clipLineBeg a {@link Point} which defines some point on the second line
+     * @param clipLineEnd a {@link Point} which defines another point on the second line
+     * @return the intersection {@link Point}
+     */
     protected Point getIntersectionPoint(Point lineBeg, Point lineEnd, Point clipLineBeg, Point clipLineEnd) {
         double A1 = lineBeg.getY() - lineEnd.getY(), A2 = clipLineBeg.getY() - clipLineEnd.getY();
         double B1 = lineEnd.getX() - lineBeg.getX(), B2 = clipLineEnd.getX() - clipLineBeg.getX();
diff --git a/layout/src/main/java/com/itextpdf/layout/borders/GrooveBorder.java b/layout/src/main/java/com/itextpdf/layout/borders/GrooveBorder.java
@@ -48,6 +48,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.colors.DeviceGray;
 import com.itextpdf.kernel.colors.DeviceRgb;
 
+/**
+ * Represents a {@link Border3D} with a groove effect being applied.
+ */
 public class GrooveBorder extends Border3D {
 
     /**
diff --git a/layout/src/main/java/com/itextpdf/layout/borders/InsetBorder.java b/layout/src/main/java/com/itextpdf/layout/borders/InsetBorder.java
@@ -48,6 +48,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.colors.DeviceGray;
 import com.itextpdf.kernel.colors.DeviceRgb;
 
+/**
+ * Represents a {@link Border3D} with an inset effect being applied.
+ */
 public class InsetBorder extends Border3D {
 
     /**
diff --git a/layout/src/main/java/com/itextpdf/layout/borders/OutsetBorder.java b/layout/src/main/java/com/itextpdf/layout/borders/OutsetBorder.java
@@ -48,6 +48,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.colors.DeviceGray;
 import com.itextpdf.kernel.colors.DeviceRgb;
 
+/**
+ * Represents a {@link Border3D} with an outset effect being applied.
+ */
 public class OutsetBorder extends Border3D {
 
     /**
diff --git a/layout/src/main/java/com/itextpdf/layout/borders/RidgeBorder.java b/layout/src/main/java/com/itextpdf/layout/borders/RidgeBorder.java
@@ -48,6 +48,9 @@ This file is part of the iText (R) project.
 import com.itextpdf.kernel.colors.DeviceGray;
 import com.itextpdf.kernel.colors.DeviceRgb;
 
+/**
+ * Represents a {@link Border3D} with a ridge effect being applied.
+ */
 public class RidgeBorder extends Border3D {
 
     /**
diff --git a/layout/src/main/java/com/itextpdf/layout/element/Div.java b/layout/src/main/java/com/itextpdf/layout/element/Div.java
@@ -102,11 +102,25 @@ public AccessibilityProperties getAccessibilityProperties() {
         return tagProperties;
     }
 
+    /**
+     * Defines whether the {@link Div} should occupy all the space left in the available area
+     * in case it is the last element in this area.
+     *
+     * @param fillArea defines whether the available area should be filled
+     * @return this {@link Div}
+     */
     public Div setFillAvailableArea(boolean fillArea) {
         setProperty(Property.FILL_AVAILABLE_AREA, fillArea);
         return this;
     }
 
+    /**
+     * Defines whether the {@link Div} should occupy all the space left in the available area
+     * in case the area has been split and it is the last element in the split part of this area.
+     *
+     * @param fillAreaOnSplit defines whether the available area should be filled
+     * @return this {@link Div}
+     */
     public Div setFillAvailableAreaOnSplit(boolean fillAreaOnSplit) {
         setProperty(Property.FILL_AVAILABLE_AREA_ON_SPLIT, fillAreaOnSplit);
         return this;
diff --git a/layout/src/main/java/com/itextpdf/layout/element/Paragraph.java b/layout/src/main/java/com/itextpdf/layout/element/Paragraph.java
@@ -92,37 +92,43 @@ public Paragraph(Text text) {
     }
 
     /**
-     * Adds a piece of text to the Paragraph
+     * Adds a piece of text to this {@link Paragraph}.
      *
      * @param text the content to be added, as a {@link String}
-     * @return this Paragraph
+     * @return this {@link Paragraph}
      */
     public Paragraph add(String text) {
         return add(new Text(text));
     }
 
     /**
-     * Adds a layout element to the Paragraph.
+     * Adds a {@link ILeafElement element} to this {@link Paragraph}.
      *
      * @param element the content to be added, any {@link ILeafElement}
-     * @return this Paragraph
+     * @return this {@link Paragraph}
      */
     public Paragraph add(ILeafElement element) {
         childElements.add(element);
         return this;
     }
 
+    /**
+     * Adds an {@link IBlockElement element} to this {@link Paragraph}.
+     *
+     * @param element the content to be added, any {@link IBlockElement}
+     * @return this {@link Paragraph}
+     */
     public Paragraph add(IBlockElement element) {
         childElements.add(element);
         return this;
     }
 
     /**
-     * Adds a {@link java.util.List} of layout elements to the Paragraph.
+     * Adds a {@link java.util.List} of layout elements to this {@link Paragraph}.
      *
      * @param elements the content to be added
      * @param <T2>      any {@link ILeafElement}
-     * @return this Paragraph
+     * @return this {@link Paragraph}
      */
     public <T2 extends ILeafElement> Paragraph addAll(java.util.List<T2> elements) {
         for (ILeafElement element : elements) {
@@ -132,10 +138,10 @@ public <T2 extends ILeafElement> Paragraph addAll(java.util.List<T2> elements) {
     }
 
     /**
-     * Adds an unspecified amount of tabstop elements as properties to the Paragraph.
+     * Adds an unspecified amount of tabstop elements as properties to this {@link Paragraph}.
      *
      * @param tabStops the {@link TabStop tabstop(s)} to be added as properties
-     * @return this Paragraph
+     * @return this {@link Paragraph}
      * @see TabStop
      */
     public Paragraph addTabStops(TabStop... tabStops) {
@@ -144,10 +150,10 @@ public Paragraph addTabStops(TabStop... tabStops) {
     }
 
     /**
-     * Adds a {@link java.util.List} of tabstop elements as properties to the Paragraph.
+     * Adds a {@link java.util.List} of tabstop elements as properties to this {@link Paragraph}.
      *
      * @param tabStops the list of {@link TabStop}s to be added as properties
-     * @return this Paragraph
+     * @return this {@link Paragraph}
      * @see TabStop
      */
     public Paragraph addTabStops(java.util.List<TabStop> tabStops) {
diff --git a/layout/src/main/java/com/itextpdf/layout/element/Table.java b/layout/src/main/java/com/itextpdf/layout/element/Table.java
@@ -828,16 +828,36 @@ public List<Border> getLastRowBottomBorder() {
         return horizontalBorder;
     }
 
+    /**
+     * Defines whether the {@link Table} should be extended to occupy all the space left in the available area
+     * in case it is the last element in this area.
+     *
+     * @param isExtended defines whether the {@link Table} should be extended
+     * @return this {@link Table}
+     */
     public Table setExtendBottomRow(boolean isExtended) {
         setProperty(Property.FILL_AVAILABLE_AREA, isExtended);
         return this;
     }
 
+    /**
+     * Defines whether the {@link Table} should be extended to occupy all the space left in the available area
+     * in case the area has been split and it is the last element in the split part of this area.
+     *
+     * @param isExtended defines whether the {@link Table} should be extended
+     * @return this {@link Table}
+     */
     public Table setExtendBottomRowOnSplit(boolean isExtended) {
         setProperty(Property.FILL_AVAILABLE_AREA_ON_SPLIT, isExtended);
         return this;
     }
 
+    /**
+     * Sets the type of border collapse.
+     *
+     * @param collapsePropertyValue {@link BorderCollapsePropertyValue} to be set as the border collapse type
+     * @return this {@link Table}
+     */
     public Table setBorderCollapse(BorderCollapsePropertyValue collapsePropertyValue) {
         setProperty(Property.BORDER_COLLAPSE, collapsePropertyValue);
         if (null != header) {
@@ -849,6 +869,12 @@ public Table setBorderCollapse(BorderCollapsePropertyValue collapsePropertyValue
         return this;
     }
 
+    /**
+     * Sets the horizontal spacing between this {@link Table table}'s {@link Cell cells}.
+     *
+     * @param spacing a horizontal spacing between this {@link Table table}'s {@link Cell cells}
+     * @return this {@link Table}
+     */
     public Table setHorizontalBorderSpacing(float spacing) {
         setProperty(Property.HORIZONTAL_BORDER_SPACING, spacing);
         if (null != header) {
@@ -860,6 +886,12 @@ public Table setHorizontalBorderSpacing(float spacing) {
         return this;
     }
 
+    /**
+     * Sets the vertical spacing between this {@link Table table}'s {@link Cell cells}.
+     *
+     * @param spacing a vertical spacing between this {@link Table table}'s {@link Cell cells}
+     * @return this {@link Table}
+     */
     public Table setVerticalBorderSpacing(float spacing) {
         setProperty(Property.VERTICAL_BORDER_SPACING, spacing);
         if (null != header) {
