Cover several layout classes with documentation

DEVSIX-6675

Author: AnhelinaM

layout/src/main/java/com/itextpdf/layout/element/AbstractElement.java

@@ -190,5 +190,10 @@ public T setPageNumber(int pageNumber) {
         return (T) (Object) this;
     }
 
+    /**
+     * Creates new renderer instance.
+     *
+     * @return new {@link IRenderer}
+     */
     protected abstract IRenderer makeNewRenderer();
 }

layout/src/main/java/com/itextpdf/layout/element/Cell.java

@@ -228,6 +228,15 @@ protected IRenderer makeNewRenderer() {
         return new CellRenderer(this);
     }
 
+    /**
+     * Updates cell indexes.
+     *
+     * @param row the number of the row to update
+     * @param col the number of the col to update
+     * @param numberOfColumns to evaluate new colspan
+     *
+     * @return this {@link Cell} with updated fields
+     */
     protected Cell updateCellIndexes(int row, int col, int numberOfColumns) {
         this.row = row;
         this.col = col;

layout/src/main/java/com/itextpdf/layout/element/FlexContainer.java

@@ -45,8 +45,14 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.renderer.FlexContainerRenderer;
 import com.itextpdf.layout.renderer.IRenderer;
 
+/**
+ * A {@link FlexContainer} represents a container of the flex objects.
+ */
 class FlexContainer extends Div {
 
+    /**
+     * Creates new {@link FlexContainer} instance.
+     */
     public FlexContainer() {
         super();
     }

layout/src/main/java/com/itextpdf/layout/element/IBlockElement.java

@@ -42,5 +42,10 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout.element;
 
+/**
+ * This class represents a block layout element with special margins, tabbing, and alignment.
+ * An {@link IBlockElement} will try to take up as much horizontal space as available to it
+ * on the canvas or page. The concept is comparable to the block element in HTML.
+ */
 public interface IBlockElement extends IAbstractElement {
 }

layout/src/main/java/com/itextpdf/layout/element/TabStop.java

@@ -100,30 +100,69 @@ public TabStop(float tabPosition, TabAlignment tabAlignment, ILineDrawer tabLead
         this.tabAnchor = '.';
     }
 
+    /**
+     * Returns the position of a tab stop.
+     *
+     * @return tabPosition, measured in absolute points
+     */
     public float getTabPosition() {
         return tabPosition;
     }
 
+    /**
+     * Returns the alignment of a tab stop, which defines the way the textual content
+     * should be positioned in regard to this tab stop.
+     *
+     * @return a {@link TabAlignment} value
+     */
     public TabAlignment getTabAlignment() {
         return tabAlignment;
     }
 
+    /**
+     * Sets the alignment, which defines the way the textual content
+     * should be positioned in regard to this tab stop.
+     *
+     * @param tabAlignment a {@link TabAlignment} value
+     */
     public void setTabAlignment(TabAlignment tabAlignment) {
         this.tabAlignment = tabAlignment;
     }
 
+    /**
+     * Returns the anchor of a tab stop.
+     *
+     * @return a {@link Character} value
+     */
     public Character getTabAnchor() {
         return tabAnchor;
     }
 
+    /**
+     * Sets the anchor of a tab stop.
+     *
+     * @param tabAnchor a {@link Character} value
+     */
     public void setTabAnchor(Character tabAnchor) {
         this.tabAnchor = tabAnchor;
     }
 
+    /**
+     * Returns the tab leader of a tab stop, which defines a pattern that
+     * should be repeated until the TabStop is reached.
+     *
+     * @return a {@link ILineDrawer} value, a pattern drawing object
+     */
     public ILineDrawer getTabLeader() {
         return tabLeader;
     }
 
+    /**
+     * Sets the tab leader of a tab stop, which defines a pattern that
+     * should be repeated until the TabStop is reached.
+     *
+     * @param tabLeader a {@link ILineDrawer} value
+     */
     public void setTabLeader(ILineDrawer tabLeader) {
         this.tabLeader = tabLeader;
     }

layout/src/main/java/com/itextpdf/layout/element/Table.java

@@ -525,7 +525,6 @@ public Table setSkipLastFooter(boolean skipLastFooter) {
       * @param caption The element to be set as a caption.
       * @return this element
       */
-
     public Table setCaption(Div caption) {
         this.caption = caption;
         if (null != caption) {
@@ -941,6 +940,11 @@ private static UnitValue[] normalizeColumnWidths(int numberOfColumns) {
         return normalized;
     }
 
+    /**
+     * Returns the list of all row groups.
+     *
+     * @return a list of a {@link RowRange} which holds the row numbers of a section of a table
+     */
     protected java.util.List<RowRange> getRowGroups() {
         int lastRowWeCanFlush = currentColumn == columnWidths.length ? currentRow : currentRow - 1;
         int[] cellBottomRows = new int[columnWidths.length];

layout/src/main/java/com/itextpdf/layout/hyphenation/HyphenationConstants.java

@@ -42,6 +42,9 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout.hyphenation;
 
+/**
+ * Class containing constants to be used in hyphenation on layout level.
+ */
 public class HyphenationConstants {
 
     public static final String HYPHENATION_DEFAULT_RESOURCE = "com/itextpdf/hyph/";

layout/src/main/java/com/itextpdf/layout/hyphenation/TernaryTreeIterator.java

@@ -92,6 +92,11 @@ public Item(char p, char c) {
             child = c;
         }
 
+        /**
+         * Construct item.
+         *
+         * @param i an {@link Item}
+         */
         public Item(Item i) {
             this.parent = i.parent;
             this.child = i.child;

layout/src/main/java/com/itextpdf/layout/renderer/AreaBreakRenderer.java

@@ -52,7 +52,7 @@ This file is part of the iText (R) project.
 import java.util.List;
 
 /**
- * Renderer object for the {@link AreaBreak} layout element. Will terminate the
+ * Renderer for the {@link AreaBreak} layout element. Will terminate the
  * current content area and initialize a new one.
  */
 public class AreaBreakRenderer implements IRenderer {

layout/src/main/java/com/itextpdf/layout/renderer/BlockRenderer.java

@@ -82,8 +82,16 @@ This file is part of the iText (R) project.
 import java.util.Map;
 import java.util.Set;
 
+/**
+ * Represents a renderer for block elements.
+ */
 public abstract class BlockRenderer extends AbstractRenderer {
 
+    /**
+     * Creates a BlockRenderer from its corresponding layout object.
+     *
+     * @param modelElement the {@link IElement} which this object should manage
+     */
     protected BlockRenderer(IElement modelElement) {
         super(modelElement);
     }
@@ -583,6 +591,13 @@ public Rectangle getOccupiedAreaBBox() {
         return bBox;
     }
 
+    /**
+     * Creates a split renderer.
+     *
+     * @param layoutResult the result of content layouting
+     *
+     * @return a new {@link AbstractRenderer} instance
+     */
     protected AbstractRenderer createSplitRenderer(int layoutResult) {
         AbstractRenderer splitRenderer = (AbstractRenderer) getNextRenderer();
         splitRenderer.parent = parent;
@@ -593,6 +608,13 @@ protected AbstractRenderer createSplitRenderer(int layoutResult) {
         return splitRenderer;
     }
 
+    /**
+     * Creates an overflow renderer.
+     *
+     * @param layoutResult the result of content layouting
+     *
+     * @return a new {@link AbstractRenderer} instance
+     */
     protected AbstractRenderer createOverflowRenderer(int layoutResult) {
         AbstractRenderer overflowRenderer = (AbstractRenderer) getNextRenderer();
         overflowRenderer.parent = parent;
@@ -645,6 +667,10 @@ AbstractRenderer[] createSplitAndOverflowRenderers(int childPos, int layoutStatu
         return new AbstractRenderer[]{splitRenderer, overflowRenderer};
     }
 
+    /**
+     * This method applies vertical alignment for the occupied area
+     * of the renderer and its children renderers.
+     */
     protected void applyVerticalAlignment() {
         VerticalAlignment verticalAlignment = this.<VerticalAlignment>getProperty(Property.VERTICAL_ALIGNMENT);
         if (verticalAlignment == null || verticalAlignment == VerticalAlignment.TOP || childRenderers.isEmpty()) {
@@ -692,6 +718,12 @@ protected void applyVerticalAlignment() {
         }
     }
 
+    /**
+     * This method rotates content of the renderer and
+     * calculates correct occupied area for the rotated element.
+     *
+     * @param layoutBox a {@link Rectangle}
+     */
     protected void applyRotationLayout(Rectangle layoutBox) {
         float angle = (float) this.getPropertyAsFloat(Property.ROTATION_ANGLE);
 
@@ -775,6 +807,11 @@ protected AffineTransform createRotationTransformInsideOccupiedArea() {
         return rotationTransform;
     }
 
+    /**
+     * This method starts rotation for the renderer if rotation angle property is specified.
+     *
+     * @param canvas the {@link PdfCanvas} to draw on
+     */
     protected void beginRotationIfApplied(PdfCanvas canvas) {
         Float angle = this.getPropertyAsFloat(Property.ROTATION_ANGLE);
         if (angle != null) {
@@ -790,6 +827,11 @@ protected void beginRotationIfApplied(PdfCanvas canvas) {
         }
     }
 
+    /**
+     * This method ends rotation for the renderer if applied.
+     *
+     * @param canvas the {@link PdfCanvas} to draw on
+     */
     protected void endRotationIfApplied(PdfCanvas canvas) {
         Float angle = this.getPropertyAsFloat(Property.ROTATION_ANGLE);
         if (angle != null && hasOwnProperty(Property.ROTATION_INITIAL_HEIGHT)) {