You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by da...@apache.org on 2015/08/23 22:37:21 UTC

svn commit: r1697247 - in /openoffice/trunk/main/xmerge/source: pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ xmerge/java/org/openoffice/xmerge/converter/dom/ xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ xmerge/java/org/op...

Author: damjan
Date: Sun Aug 23 20:37:20 2015
New Revision: 1697247

URL: http://svn.apache.org/r1697247
Log:
Fix bad @return javadocs in main/xmerge.


Modified:
    openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
    openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
    openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
    openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
    openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
    openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
    openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java
    openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java
    openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java
    openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java

Modified: openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java (original)
+++ openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java Sun Aug 23 20:37:20 2015
@@ -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");

Modified: openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java (original)
+++ openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java Sun Aug 23 20:37:20 2015
@@ -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;

Modified: openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java (original)
+++ openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java Sun Aug 23 20:37:20 2015
@@ -76,21 +76,11 @@ public class Selection implements BIFFRe
         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();

Modified: openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java (original)
+++ openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java Sun Aug 23 20:37:20 2015
@@ -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 {

Modified: openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java (original)
+++ openoffice/trunk/main/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java Sun Aug 23 20:37:20 2015
@@ -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());

Modified: openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java (original)
+++ openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java Sun Aug 23 20:37:20 2015
@@ -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;

Modified: openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java (original)
+++ openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java Sun Aug 23 20:37:20 2015
@@ -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;

Modified: openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java (original)
+++ openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnStyle.java Sun Aug 23 20:37:20 2015
@@ -118,7 +118,7 @@ public class ColumnStyle extends Style i
 	/**
 	 * Sets the width of this column
 	 *
-	 * @return the <code>Format</code> object 
+	 * @param colWidth the column width
 	 */
 	public void setColWidth(int colWidth) {
 

Modified: openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java (original)
+++ openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java Sun Aug 23 20:37:20 2015
@@ -118,9 +118,9 @@ public class RowStyle extends Style impl
 	/**
 	 * 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;
 	}	

Modified: openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java
URL: http://svn.apache.org/viewvc/openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java?rev=1697247&r1=1697246&r2=1697247&view=diff
==============================================================================
--- openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java (original)
+++ openoffice/trunk/main/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/MergeAlgorithm.java Sun Aug 23 20:37:20 2015
@@ -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,