Fix bad @return javadocs in main/xmerge.

10 files changed, 11 insertions, 32 deletions

diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
index 6e85b9f50a09..8886823f947e 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
@@ -126,7 +126,7 @@ public class LabelCell extends CellValue {
     /**
      * Sets the <code>String</code> representing the cells contents
      *
-     * @return the <code>String</code> representing the cells contents
+     * @param cellContents the <code>String</code> representing the cells contents
      */
     private void setLabel(String cellContents) throws IOException {
         rgch = cellContents.getBytes("UTF-16LE");
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
index ff718c7286b5..f3555387f94e 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
@@ -120,9 +120,11 @@ public class Pane implements BIFFRecord {
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Set the pane number of the active pane
+         * 0 - bottom right, 1 - top right
+         * 2 - bottom left, 3 - top left
      *
-     * @return the hex code for <code>Pane</code>
+     * @param paneNumber the pane number of the active pane
      */
     public void setPaneNumber(int paneNumber) {
         pnnAcct = (byte) paneNumber;
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
index 3db5794cc685..70fea79f9782 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
@@ -76,21 +76,11 @@ public class Selection implements BIFFRecord {
         return PocketExcelConstants.CURRENT_SELECTION;
     }
 
-    /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
-     *
-     * @return the hex code for <code>Selection</code>
-     */
     public Point getActiveCell() {
         Point p = new Point(colActive, EndianConverter.readShort(rwActive));
         return p;
     }
 
-    /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
-     *
-     * @return the hex code for <code>Selection</code>
-     */
     public void setActiveCell(Point p) {
 
         colActive = (byte) p.getX();
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
index 8f9829773f81..8e4aac3aa837 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
@@ -358,7 +358,7 @@ OfficeConstants {
     /**
      * Adds a <code>Worksheet</code> to the workbook.
      *
-     * @return name the name of the <code>Worksheet</code> to be added
+     * @param name the name of the <code>Worksheet</code> to be added
      */
     public void addWorksheet(String name) throws IOException {
 
@@ -372,7 +372,6 @@ OfficeConstants {
     /**
      * Adds a cell to the current worksheet.
      *
-     * @return the name of the <code>Worksheet</code> to be added
      */
     public void addCell(int row,int col, Format fmt, String cellContents)
     throws IOException {
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
index 9b9fe8768488..0aa9b30e73d7 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
@@ -247,11 +247,7 @@ public class Worksheet {
     public void addCol(ColInfo c) {
         colInfo.add(c);
     }
-    /**
-     * Returns an <code>Enumeration</code> to the ColInfo's for this worksheet
-     *
-     * @return an <code>Enumeration</code> to the ColInfo's
-     */
+
     public void addSettings(SheetSettings s) {
 
         sel.setActiveCell(s.getCursor());
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
index c301c93efe3e..09fb5777847f 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
@@ -153,7 +153,7 @@ public class DOMDocument
      *  Sets the Content of the <code>Document</code> to the contents of the
      *  supplied <code>Node</code> list.
      *
-     *  @return  DOM <code>Document</code> object.
+     *  @param newDom  DOM <code>Document</code> object.
      */
     public void setContentDOM( Node newDom) {
     contentDoc=(Document)newDom;
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java
index 963602975d19..12aab3fef422 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java
@@ -127,11 +127,6 @@ public class ColumnRowInfo {
         return repeated;
     }
 
-    /**
-     * Returns the base Cell address
-     *
-     * @return the base cell address
-     */
     public void setRepeated(int repeated) {
 
         this.repeated = repeated;
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java
index e6987c041382..0bc5d34efaad 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java
@@ -118,7 +118,7 @@ public class ColumnStyle extends Style implements Cloneable {
     /**
      * Sets the width of this column
      *
-     * @return the <code>Format</code> object
+     * @param colWidth the column width
      */
     public void setColWidth(int colWidth) {
 
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java
index 8e8054c446fe..e75fcfe4eb26 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java
@@ -118,9 +118,9 @@ public class RowStyle extends Style implements Cloneable {
     /**
      * Sets the height of this row
      *
-     * @return the <code>Format</code> object
+     * @param rowHeight the row height
      */
-    public void setRowHeight(int RowHeight) {
+    public void setRowHeight(int rowHeight) {
 
         this.rowHeight = rowHeight;
     }
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java
index 7b61475fcec1..122cb7204af1 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java
@@ -46,9 +46,6 @@ public interface MergeAlgorithm {
      *                       content will be extracted.
      *  @param  differences  The <code>Difference</code> array.
      *
-     *  @return  An <code>Iterator</code> which is the modified original
-     *           <code>Iterator</code> Sequence.  Same as the first parameter.
-     *
      *  @throws  MergeException  If an error occurs during the merge.
      */
     public void applyDifference(Iterator orgSeq, Iterator modSeq,