From 9a93f7ce02ddce11da85d4ed18cdf52ea2586449 Mon Sep 17 00:00:00 2001
From: Nigel Hawkins <n.hawkins@gmx.com>
Date: Thu, 28 Oct 2010 09:08:10 +0100
Subject: Fix javadoc comments in ColumnRowInfo.java

---
 .../xmerge/converter/xml/sxc/ColumnRowInfo.java    | 50 ++++++++++++----------
 1 file changed, 27 insertions(+), 23 deletions(-)

(limited to 'xmerge')

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 14c1dbfc8e77..8b39e469ad4c 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
@@ -50,8 +50,7 @@ public class ColumnRowInfo {
     /**
      * Constructor for a <code>ColumnRowInfo</code>
      *
-     * @param dimension if it's a row the height, a column the width
-     * @param repeated
+     * @param type whether ROW or COLUMN record .
      */
     public ColumnRowInfo(int type) {
 
@@ -61,9 +60,9 @@ public class ColumnRowInfo {
     /**
      * Constructor for a <code>ColumnRowInfo</code>
      *
-     * @param dimension if it's a row the height, a column the width
-     * @param repeated how many times it is repeated
-     * @param type whether Row or column record
+     * @param dimension if it's a row the height, a column the width.
+     * @param repeated how many times it is repeated.
+     * @param type whether ROW or COLUMN record.
      */
     public ColumnRowInfo(int dimension, int repeated, int type) {
 
@@ -73,9 +72,13 @@ public class ColumnRowInfo {
     }
 
     /**
-     * Constructor that includes userDefined field
+     * Constructor for a <code>ColumnRowInfo</code> that includes userDefined
+     * field.
      *
-     * @param userDefined whether the record is manually set
+     * @param dimension if it's a row the height, a column the width.
+     * @param repeated how many times it is repeated.
+     * @param type whether ROW or COLUMN record.
+     * @param userDefined whether the record is manually set.
      */
     public ColumnRowInfo(int dimension, int repeated, int type, boolean userDefined) {
 
@@ -84,9 +87,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * sets the definition
+     * Sets the format.
      *
-     * @param newDefinition sets the definition
+     * @param fmt The new format to use.
      */
     public void setFormat(Format fmt) {
 
@@ -94,9 +97,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * returns Name of the definition
+     * Get the current format.
      *
-     * @return the name which identifies the definition
+     * @return The current format.
      */
     public Format getFormat() {
 
@@ -104,9 +107,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * returns Name of the definition
+     * Get the height (for rows) or width (for columns).
      *
-     * @return the name which identifies the definition
+     * @return The height or width.
      */
     public int getSize() {
 
@@ -114,18 +117,19 @@ public class ColumnRowInfo {
     }
 
     /**
-     * sets the definition
+     * Set the height (for rows) or width (for columns).
      *
-     * @param newDefinition sets the definition
+     * @param dimension The height or width.
      */
     public void setSize(int dimension) {
 
         this.dimension = dimension;
     }
+
     /**
-     * Returns the definition itself
+     * Get the repeat count for this item.
      *
-     * @return the definition
+     * @return The number of times this item is repeated.
      */
     public int getRepeated() {
 
@@ -133,9 +137,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * Returns the base Cell address
+     * Set the repeat count for this item.
      *
-     * @return the base cell address
+     * @param repeated The number of times this item is repeated.
      */
     public void setRepeated(int repeated) {
 
@@ -143,9 +147,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * Returns the definition itself
+     * Does this <code>ColumnRowInfo</code> represent a row?
      *
-     * @return the definition
+     * @return True if a row, false if not.
      */
     public boolean isRow() {
 
@@ -156,9 +160,9 @@ public class ColumnRowInfo {
     }
 
     /**
-     * Returns the base Cell address
+     * Does this <code>ColumnRowInfo</code> represent a column?
      *
-     * @return the base cell address
+     * @return True if a column, false if not.
      */
     public boolean isColumn() {
 
-- 
cgit