Add javadocs for layout module

DEVSIX-5535

Author: nikitakovaliov92

layout/src/main/java/com/itextpdf/layout/layout/LayoutContext.java

@@ -55,40 +55,78 @@ This file is part of the iText (R) project.
 public class LayoutContext {
 
     /**
-     * The {@link LayoutArea area} the content to be placed on.
+     * The {@link LayoutArea} for the content to be placed on.
      */
     protected LayoutArea area;
 
+    /**
+     * The info about margins collapsing.
+     */
     protected MarginsCollapseInfo marginsCollapseInfo;
 
+    /**
+     * The list of {@link Rectangle} objects.
+     */
     protected List<Rectangle> floatRendererAreas = new ArrayList<>();
 
     /**
      * Indicates whether the height is clipped or not.
      */
     protected boolean clippedHeight = false;
 
+    /**
+     * Creates the layout context.
+     *
+     * @param area for the content to be placed on
+     */
     public LayoutContext(LayoutArea area) {
         this.area = area;
     }
 
+    /**
+     * Creates the layout context.
+     *
+     * @param area for the content to be placed on
+     * @param marginsCollapseInfo the info about margins collapsing
+     */
     public LayoutContext(LayoutArea area, MarginsCollapseInfo marginsCollapseInfo) {
         this.area = area;
         this.marginsCollapseInfo = marginsCollapseInfo;
     }
 
+    /**
+     * Creates the layout context.
+     *
+     * @param area for the content to be placed on
+     * @param marginsCollapseInfo the info about margins collapsing
+     * @param floatedRendererAreas list of {@link Rectangle} objects
+     */
     public LayoutContext(LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, List<Rectangle> floatedRendererAreas) {
         this(area, marginsCollapseInfo);
         if (floatedRendererAreas != null) {
             this.floatRendererAreas = floatedRendererAreas;
         }
     }
 
+    /**
+     * Creates the layout context.
+     *
+     * @param area for the content to be placed on
+     * @param clippedHeight indicates whether the height is clipped or not
+     */
     public LayoutContext(LayoutArea area, boolean clippedHeight) {
         this(area);
         this.clippedHeight = clippedHeight;
     }
 
+    /**
+     * Creates the layout context.
+     *
+     * @param area for the content to be placed on
+     * @param marginsCollapseInfo the info about margins collapsing
+     * @param floatedRendererAreas list of {@link Rectangle} objects
+     * @param clippedHeight indicates whether the height is clipped or not
+     */
     public LayoutContext(LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, List<Rectangle> floatedRendererAreas, boolean clippedHeight) {
         this(area, marginsCollapseInfo);
         if (floatedRendererAreas != null) {
@@ -106,10 +144,20 @@ public LayoutArea getArea() {
         return area;
     }
 
+    /**
+     * Gets info about margins collapsing.
+     *
+     * @return the info about margins collapsing
+     */
     public MarginsCollapseInfo getMarginsCollapseInfo() {
         return marginsCollapseInfo;
     }
 
+    /**
+     * Gets list of {@link Rectangle} objects.
+     *
+     * @return list of {@link Rectangle} objects
+     */
     public List<Rectangle> getFloatRendererAreas() {
         return floatRendererAreas;
     }

layout/src/main/java/com/itextpdf/layout/layout/LayoutResult.java

@@ -88,6 +88,9 @@ public class LayoutResult {
      * This renderer will be used to draw the overflowed part of content.
      */
     protected IRenderer overflowRenderer;
+    /**
+     * The {@link AreaBreak} that will be rendered by this object.
+     */
     protected AreaBreak areaBreak;
 
     /**
@@ -189,10 +192,21 @@ public void setOverflowRenderer(IRenderer overflowRenderer) {
         this.overflowRenderer = overflowRenderer;
     }
 
+    /**
+     * Gets areaBreak value.
+     *
+     * @return the areaBreak value
+     */
     public AreaBreak getAreaBreak() {
         return areaBreak;
     }
 
+    /**
+     * Sets areaBreak value.
+     *
+     * @param areaBreak the areaBreak value
+     * @return the areaBreak value
+     */
     public LayoutResult setAreaBreak(AreaBreak areaBreak) {
         this.areaBreak = areaBreak;
         return this;

layout/src/main/java/com/itextpdf/layout/layout/LineLayoutContext.java

@@ -53,10 +53,23 @@ public class LineLayoutContext extends LayoutContext {
     private boolean floatOverflowedToNextPageWithNothing = false;
     private float textIndent;
 
+    /**
+     * Creates the context for content of a line.
+     *
+     * @param area for the content to be placed on
+     * @param marginsCollapseInfo the info about margins collapsing
+     * @param floatedRendererAreas list of {@link Rectangle} objects
+     * @param clippedHeight indicates whether the height is clipped or not
+     */
     public LineLayoutContext(LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, List<Rectangle> floatedRendererAreas, boolean clippedHeight) {
         super(area, marginsCollapseInfo, floatedRendererAreas, clippedHeight);
     }
 
+    /**
+     * Creates the context for content of a line.
+     *
+     * @param layoutContext the context for content layouting
+     */
     public LineLayoutContext(LayoutContext layoutContext) {
         super(layoutContext.area, layoutContext.marginsCollapseInfo, layoutContext.floatRendererAreas, layoutContext.clippedHeight);
     }

layout/src/main/java/com/itextpdf/layout/layout/LineLayoutResult.java

@@ -95,21 +95,30 @@ public boolean isSplitForcedByNewline() {
     }
 
     /**
-     * Sets {@link #setSplitForcedByNewline}
+     * Sets a flat that split was forced by new line symbol in rendered text.
      *
      * @param isSplitForcedByNewline indicates that split was forced by new line symbol in rendered text.
      * @return {@link com.itextpdf.layout.layout.LineLayoutResult this layout result} the setting was applied on.
-     * @see #setSplitForcedByNewline
      */
     public LineLayoutResult setSplitForcedByNewline(boolean isSplitForcedByNewline) {
         this.splitForcedByNewline = isSplitForcedByNewline;
         return this;
     }
 
+    /**
+     * Gets the list of floats overflowed to next page.
+     *
+     * @return list of floats overflowed to next page
+     */
     public List<IRenderer> getFloatsOverflowedToNextPage() {
         return floatsOverflowedToNextPage;
     }
 
+    /**
+     * Sets the list of floats overflowed to next page.
+     *
+     * @param floatsOverflowedToNextPage the floats overflowed to next page
+     */
     public void setFloatsOverflowedToNextPage(List<IRenderer> floatsOverflowedToNextPage) {
         this.floatsOverflowedToNextPage = floatsOverflowedToNextPage;
     }

layout/src/main/java/com/itextpdf/layout/layout/MinMaxWidthLayoutResult.java

@@ -51,22 +51,53 @@ This file is part of the iText (R) project.
  */
 public class MinMaxWidthLayoutResult extends LayoutResult {
 
+    /**
+     * The {@link MinMaxWidth} value of min and max width.
+     */
     protected MinMaxWidth minMaxWidth;
 
+    /**
+     * Creates min and max width.
+     *
+     * @param status the status which indicates the content
+     * @param occupiedArea the area occupied by the content
+     * @param splitRenderer the renderer to draw the splitted part of the content
+     * @param overflowRenderer the renderer to draw the overflowed part of the content
+     */
     public MinMaxWidthLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer) {
         super(status, occupiedArea, splitRenderer, overflowRenderer);
         minMaxWidth = new MinMaxWidth();
     }
 
+    /**
+     * Creates min and max width.
+     *
+     * @param status the status which indicates the content
+     * @param occupiedArea the area occupied by the content
+     * @param splitRenderer the renderer to draw the splitted part of the content
+     * @param overflowRenderer the renderer to draw the overflowed part of the content
+     * @param cause the first renderer to produce {@link LayoutResult#NOTHING}
+     */
     public MinMaxWidthLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause) {
         super(status, occupiedArea, splitRenderer, overflowRenderer, cause);
         minMaxWidth = new MinMaxWidth();
     }
 
+    /**
+     * Gets min and max width.
+     *
+     * @return min and max width
+     */
     public MinMaxWidth getMinMaxWidth() {
         return minMaxWidth;
     }
 
+    /**
+     * Sets min and max width.
+     *
+     * @param minMaxWidth min and max width
+     * @return min and max width
+     */
     public MinMaxWidthLayoutResult setMinMaxWidth(MinMaxWidth minMaxWidth) {
         this.minMaxWidth = minMaxWidth;
         return this;

layout/src/main/java/com/itextpdf/layout/layout/PositionedLayoutContext.java

@@ -42,17 +42,30 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout.layout;
 
+/**
+ * Represents the result of positioning for layout context.
+ */
 public class PositionedLayoutContext extends LayoutContext {
 
     private LayoutArea parentOccupiedArea;
 
+    /**
+     * Creates position for layout context.
+     *
+     * @param area for the content to be placed on
+     * @param parentOccupiedArea the parent content to be placed on
+     */
     public PositionedLayoutContext(LayoutArea area, LayoutArea parentOccupiedArea) {
         super(area);
         this.parentOccupiedArea = parentOccupiedArea;
     }
 
+    /**
+     * Gets the value of the parent occupied area.
+     *
+     * @return the parent occupied area
+     */
     public LayoutArea getParentOccupiedArea() {
         return parentOccupiedArea;
     }
-
 }

layout/src/main/java/com/itextpdf/layout/layout/RootLayoutArea.java

@@ -45,14 +45,20 @@ This file is part of the iText (R) project.
 
 import com.itextpdf.kernel.geom.Rectangle;
 
+/**
+ * Represents the root layout area.
+ */
 public class RootLayoutArea extends LayoutArea implements Cloneable {
     /**
      * Indicates whether the area already has some placed content or not.
      */
     protected boolean emptyArea = true;
 
     /**
-     * {@inheritDoc}
+     * Creates the root layout area.
+     *
+     * @param pageNumber the value number of page
+     * @param bBox the bounding box
      */
     public RootLayoutArea(int pageNumber, Rectangle bBox) {
         super(pageNumber, bBox);