style changes only

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

1 files changed, 36 insertions, 11 deletions

diff --git a/src/java/org/apache/fop/fo/StringProperty.java b/src/java/org/apache/fop/fo/StringProperty.java
index ef5fa9028..2986e7ca5 100644
--- a/src/java/org/apache/fop/fo/StringProperty.java
+++ b/src/java/org/apache/fop/fo/StringProperty.java
@@ -3,34 +3,34 @@
  * ============================================================================
  *                    The Apache Software License, Version 1.1
  * ============================================================================
- * 
+ *
  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- * 
+ *
  * Redistribution and use in source and binary forms, with or without modifica-
  * tion, are permitted provided that the following conditions are met:
- * 
+ *
  * 1. Redistributions of source code must retain the above copyright notice,
  *    this list of conditions and the following disclaimer.
- * 
+ *
  * 2. Redistributions in binary form must reproduce the above copyright notice,
  *    this list of conditions and the following disclaimer in the documentation
  *    and/or other materials provided with the distribution.
- * 
+ *
  * 3. The end-user documentation included with the redistribution, if any, must
  *    include the following acknowledgment: "This product includes software
  *    developed by the Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowledgment may appear in the software itself, if
  *    and wherever such third-party acknowledgments normally appear.
- * 
+ *
  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
  *    endorse or promote products derived from this software without prior
  *    written permission. For written permission, please contact
  *    apache@apache.org.
- * 
+ *
  * 5. Products derived from this software may not be called "Apache", nor may
  *    "Apache" appear in their name, without prior written permission of the
  *    Apache Software Foundation.
- * 
+ *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
@@ -42,23 +42,39 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  * ============================================================================
- * 
+ *
  * This software consists of voluntary contributions made by many individuals
  * on behalf of the Apache Software Foundation and was originally created by
  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
  * Software Foundation, please see <http://www.apache.org/>.
- */ 
+ */
 package org.apache.fop.fo;
 
-
+/**
+ * Exists primarily as a container for its Maker inner class, which is
+ * extended by many string-based FO property classes.
+ */
 public class StringProperty extends Property {
 
+    /**
+     * Inner class for making instances of StringProperty
+     */
     public static class Maker extends Property.Maker {
 
+        /**
+         * @param propName name of property for which to create a Maker
+         */
         public Maker(String propName) {
             super(propName);
         }
 
+        /**
+         * Make a new StringProperty object
+         * @param propertyList not used
+         * @param value String value of the new object
+         * @param fo not used
+         * @return the StringProperty object
+         */
         public Property make(PropertyList propertyList, String value,
                              FObj fo) {
             // Work around the fact that most String properties are not
@@ -91,15 +107,24 @@ public class StringProperty extends Property {
 
     private String str;
 
+    /**
+     * @param str String value to place in this object
+     */
     public StringProperty(String str) {
         this.str = str;
         // System.err.println("Set StringProperty: " + str);
     }
 
+    /**
+     * @return the Object equivalent of this property
+     */
     public Object getObject() {
         return this.str;
     }
 
+    /**
+     * @return the String equivalent of this property
+     */
     public String getString() {
         return this.str;
     }