improved jdoc

Author: rbri

src/main/java/org/htmlunit/html/HtmlStyle.java

@@ -125,6 +125,8 @@ public boolean mayBeDisplayed() {
     }
 
     /**
+     * Return the referenced style sheet.
+     *
      * @return the referenced style sheet
      */
     public CssStyleSheet getSheet() {

src/main/java/org/htmlunit/html/HtmlTable.java

@@ -110,15 +110,19 @@ public final HtmlTableCell getCellAt(final int rowIndex, final int columnIndex)
     }
 
     /**
-     * @return an iterator over all the HtmlTableRow objects
+     * Returns an iterator over all rows in this table.
+     *
+     * @return an iterator over all {@link HtmlTableRow} objects
      */
     private RowIterator getRowIterator() {
         return new RowIterator();
     }
 
     /**
-     * @return an immutable list containing all the HtmlTableRow objects
-     * @see #getRowIterator
+     * Returns an immutable list of all rows in this table.
+     *
+     * @return an immutable list containing all {@link HtmlTableRow} objects
+     * @see #getRowIterator()
      */
     public List<HtmlTableRow> getRows() {
         final List<HtmlTableRow> result = new ArrayList<>();
@@ -129,10 +133,12 @@ public List<HtmlTableRow> getRows() {
     }
 
     /**
+     * Returns the row at the specified index.
+     *
      * @param index the 0-based index of the row
-     * @return the HtmlTableRow at the given index
+     * @return the {@link HtmlTableRow} at the given index
      * @throws IndexOutOfBoundsException if there is no row at the given index
-     * @see #getRowIterator
+     * @see #getRowIterator()
      */
     public HtmlTableRow getRow(final int index) throws IndexOutOfBoundsException {
         int count = 0;
@@ -160,11 +166,11 @@ public final int getRowCount() {
     }
 
     /**
-     * Finds and return the row with the specified id.
+     * Returns the row with the specified identifier.
      *
-     * @param id the id of the row
-     * @return the row with the specified id
-     * @exception ElementNotFoundException If the row cannot be found.
+     * @param id the row identifier
+     * @return the row with the specified identifier
+     * @throws ElementNotFoundException if the row cannot be found
      */
     public final HtmlTableRow getRowById(final String id) throws ElementNotFoundException {
         for (final HtmlTableRow row : getRowIterator()) {
@@ -355,24 +361,23 @@ private class RowIterator implements Iterator<HtmlTableRow>, Iterable<HtmlTableR
         }
 
         /**
-         * @return {@code true} if there are more rows available
+         * {@inheritDoc}
          */
         @Override
         public boolean hasNext() {
             return nextRow_ != null;
         }
 
         /**
-         * @return the next row from this iterator
-         * @throws NoSuchElementException if no more rows are available
+         * {@inheritDoc}
          */
         @Override
         public HtmlTableRow next() throws NoSuchElementException {
             return nextRow();
         }
 
         /**
-         * Removes the current row from the underlying table.
+         * {@inheritDoc}
          */
         @Override
         public void remove() {
@@ -386,6 +391,8 @@ public void remove() {
         }
 
         /**
+         * Returns the next row.
+         *
          * @return the next row from this iterator
          * @throws NoSuchElementException if no more rows are available
          */
@@ -423,6 +430,9 @@ else if (currentGroup_ == null && next instanceof TableRowGroup group) {
             }
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public Iterator<HtmlTableRow> iterator() {
             return this;
@@ -431,7 +441,9 @@ public Iterator<HtmlTableRow> iterator() {
 
     /**
      * {@inheritDoc}
-     * @return {@code true} as browsers ignore self closing <code>table</code> tags.
+     *
+     * @return {@code true} so that generated XML uses explicit opening and closing
+     *         {@code <table>} tags
      */
     @Override
     protected boolean isEmptyXmlTagExpanded() {

src/main/java/org/htmlunit/html/HtmlTableCell.java

@@ -48,7 +48,10 @@ protected HtmlTableCell(final String qualifiedName, final SgmlPage page,
     }
 
     /**
-     * @return the value of the colspan attribute, or <code>1</code> if the attribute wasn't specified
+     * Returns the column span of this cell.
+     *
+     * @return the value of the {@code colspan} attribute, or {@code 1} if the
+     *         attribute was not specified or is invalid
      */
     public int getColumnSpan() {
         final String spanString = StringUtils.replaceChars(getAttributeDirect("colspan"), "\r\n\t ", null);
@@ -68,7 +71,10 @@ public int getColumnSpan() {
     }
 
     /**
-     * @return the value of the rowspan attribute, or <code>1</code> if the attribute wasn't specified
+     * Returns the row span of this cell.
+     *
+     * @return the value of the {@code rowspan} attribute, or {@code 1} if the
+     *         attribute was not specified or is invalid
      */
     public int getRowSpan() {
         final String spanString = StringUtils.replaceChars(getAttributeDirect("rowspan"), "\r\n\t ", null);

src/main/java/org/htmlunit/html/HtmlTableRow.java

@@ -51,15 +51,19 @@ public class HtmlTableRow extends HtmlElement {
     }
 
     /**
-     * @return an Iterator over the all HtmlTableCell objects in this row
+     * Returns an iterator over all cells in this row.
+     *
+     * @return an iterator over all {@link HtmlTableCell} objects in this row
      */
     public CellIterator getCellIterator() {
         return new CellIterator();
     }
 
     /**
-     * @return an immutable list containing all the HtmlTableCells held by this object
-     * @see #getCellIterator
+     * Returns an immutable list of all cells in this row.
+     *
+     * @return an immutable list containing all {@link HtmlTableCell} objects in this row
+     * @see #getCellIterator()
      */
     public List<HtmlTableCell> getCells() {
         final List<HtmlTableCell> result = new ArrayList<>();
@@ -70,6 +74,8 @@ public List<HtmlTableCell> getCells() {
     }
 
     /**
+     * Returns the cell at the specified index.
+     *
      * @param index the 0-based index
      * @return the cell at the given index
      * @throws IndexOutOfBoundsException if there is no cell at the given index
@@ -134,8 +140,9 @@ public final String getValignAttribute() {
     }
 
     /**
-     * Gets the table containing this row.
-     * @return the table
+     * Returns the table containing this row.
+     *
+     * @return the enclosing table
      */
     public HtmlTable getEnclosingTable() {
         return (HtmlTable) getEnclosingElement("table");
@@ -167,24 +174,23 @@ public CellIterator() {
         }
 
         /**
-         * @return whether there is another cell available
+         * {@inheritDoc}
          */
         @Override
         public boolean hasNext() {
             return nextCell_ != null;
         }
 
         /**
-         * @return the next cell
-         * @throws NoSuchElementException if no cell is available
+         * {@inheritDoc}
          */
         @Override
         public HtmlTableCell next() throws NoSuchElementException {
             return nextCell();
         }
 
         /**
-         * Removes the cell under the cursor from the current row.
+         * {@inheritDoc}
          */
         @Override
         public void remove() {
@@ -198,6 +204,8 @@ public void remove() {
         }
 
         /**
+         * Returns the next cell.
+         *
          * @return the next cell
          * @throws NoSuchElementException if no cell is available
          */
@@ -237,9 +245,7 @@ else if (currentForm_ == null && next instanceof HtmlForm form) {
         }
 
         /**
-         * Returns an HtmlTableCell iterator.
-         *
-         * @return an HtmlTableCell Iterator.
+         * {@inheritDoc}
          */
         @Override
         public Iterator<HtmlTableCell> iterator() {

src/main/java/org/htmlunit/html/HtmlTemplate.java

@@ -56,6 +56,8 @@ public DisplayStyle getDefaultStyleDisplay() {
     }
 
     /**
+     * Return the associated document fragment.
+     *
      * @return the associated document fragment
      */
     public DomDocumentFragment getContent() {