Adjust some JavaDoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1884918 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 14 insertions, 15 deletions

diff --git a/src/java/org/apache/poi/ddf/EscherProperty.java b/src/java/org/apache/poi/ddf/EscherProperty.java
index 35787e2b5c..63a738cec1 100644
--- a/src/java/org/apache/poi/ddf/EscherProperty.java
+++ b/src/java/org/apache/poi/ddf/EscherProperty.java
@@ -43,7 +43,7 @@ public abstract class EscherProperty implements GenericRecord {
     /**
      * The id is distinct from the actual property number.  The id includes the property number the blip id
      * flag and an indicator whether the property is complex or not.
-     * 
+     *
      * @param id the combined id
      */
     protected EscherProperty(short id) {
@@ -53,7 +53,7 @@ public abstract class EscherProperty implements GenericRecord {
     /**
      * Constructs a new escher property.  The three parameters are combined to form a property
      * id.
-     * 
+     *
      * @param propertyNumber the property number
      * @param isComplex true, if this is a complex property
      * @param isBlipId true, if this property is a blip id
@@ -68,7 +68,7 @@ public abstract class EscherProperty implements GenericRecord {
      * Constructs a new escher property.  The three parameters are combined to form a property
      * id.
      *
-     * @param propertyNumber the property number
+     * @param type one of the defined property types
      * @param isComplex true, if this is a complex property
      * @param isBlipId true, if this property is a blip id
      */
@@ -101,31 +101,31 @@ public abstract class EscherProperty implements GenericRecord {
     /**
      * Most properties are just 6 bytes in length.  Override this if we're
      * dealing with complex properties.
-     * 
+     *
      * @return size of this property (in bytes)
      */
     public int getPropertySize() {
         return 6;
     }
-    
+
     /**
      * Escher properties consist of a simple fixed length part and a complex variable length part.
      * The fixed length part is serialized first.
-     * 
+     *
      * @param data the buffer to write to
      * @param pos the starting position
-     * 
+     *
      * @return the length of the part
      */
     abstract public int serializeSimplePart( byte[] data, int pos );
-    
+
     /**
      * Escher properties consist of a simple fixed length part and a complex variable length part.
      * The fixed length part is serialized first.
-     * 
+     *
      * @param data the buffer to write to
      * @param pos the starting position
-     * 
+     *
      * @return the length of the part
      */
     abstract public int serializeComplexPart( byte[] data, int pos );
diff --git a/src/java/org/apache/poi/ddf/EscherRGBProperty.java b/src/java/org/apache/poi/ddf/EscherRGBProperty.java
index fb43e492f0..2662fb8b6b 100644
--- a/src/java/org/apache/poi/ddf/EscherRGBProperty.java
+++ b/src/java/org/apache/poi/ddf/EscherRGBProperty.java
@@ -37,7 +37,7 @@ public class EscherRGBProperty
     /**
      * Create an instance of an escher boolean property.
      *
-     * @param propertyNumber The property type
+     * @param propertyType one of the defined property types
      * @param rgbColor      The 24 bit value of this rgb property
      */
     public EscherRGBProperty( EscherPropertyTypes propertyType, int rgbColor ) {
diff --git a/src/java/org/apache/poi/ddf/EscherSimpleProperty.java b/src/java/org/apache/poi/ddf/EscherSimpleProperty.java
index c445c0a90e..592d038fcf 100644
--- a/src/java/org/apache/poi/ddf/EscherSimpleProperty.java
+++ b/src/java/org/apache/poi/ddf/EscherSimpleProperty.java
@@ -29,9 +29,8 @@ import org.apache.poi.util.LittleEndian;
  * to a 32-bit value.  Properties that can't be stored in only 32-bits are
  * stored as EscherComplexProperty objects.
  */
-public class EscherSimpleProperty extends EscherProperty
-{
-    private int propertyValue;
+public class EscherSimpleProperty extends EscherProperty {
+    private final int propertyValue;
 
     /**
      * The id is distinct from the actual property number.  The id includes the property number the blip id
@@ -72,7 +71,7 @@ public class EscherSimpleProperty extends EscherProperty
     /**
      * Constructs a new escher property.  The three parameters are combined to form a property id.
      *
-     * @param propertyNumber the property number
+     * @param type one of the defined property types
      * @param isComplex true, if its a complex property
      * @param isBlipId true, if its a blip
      * @param propertyValue the property value