style/javadoc changes only

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

diff --git a/src/java/org/apache/fop/apps/CommandLineOptions.java b/src/java/org/apache/fop/apps/CommandLineOptions.java
index d47a2aa6db23c77a0ecae81f12f9010e8ce9e6bf..f31ba95961280331c2ae33ac5e7dfe354a5af30c 100644 (file)
--- a/src/java/org/apache/fop/apps/CommandLineOptions.java
+++ b/src/java/org/apache/fop/apps/CommandLineOptions.java
@@ -64,31 +64,31 @@ import org.apache.avalon.framework.logger.Logger;
  */
 public class CommandLineOptions {
 
-    /* input / output not set */
+    /** input / output not set */
     public static final int NOT_SET = 0;
-    /* input: fo file */
+    /** input: fo file */
     public static final int FO_INPUT = 1;
-    /* input: xml+xsl file */
+    /** input: xml+xsl file */
     public static final int XSLT_INPUT = 2;
-    /* output: pdf file */
+    /** output: pdf file */
     public static final int PDF_OUTPUT = 1;
-    /* output: screen using swing */
+    /** output: screen using swing */
     public static final int AWT_OUTPUT = 2;
-    /* output: mif file */
+    /** output: mif file */
     public static final int MIF_OUTPUT = 3;
-    /* output: sent swing rendered file to printer */
+    /** output: sent swing rendered file to printer */
     public static final int PRINT_OUTPUT = 4;
-    /* output: pcl file */
+    /** output: pcl file */
     public static final int PCL_OUTPUT = 5;
-    /* output: postscript file */
+    /** output: postscript file */
     public static final int PS_OUTPUT = 6;
-    /* output: text file */
+    /** output: text file */
     public static final int TXT_OUTPUT = 7;
-    /* output: svg file */
+    /** output: svg file */
     public static final int SVG_OUTPUT = 8;
-    /* output: XML area tree */
+    /** output: XML area tree */
     public static final int AREA_OUTPUT = 9;
-    /* output: RTF file */
+    /** output: RTF file */
     public static final int RTF_OUTPUT = 10;
 
     /* show configuration information */

diff --git a/src/java/org/apache/fop/apps/Document.java b/src/java/org/apache/fop/apps/Document.java
index e7b9dc07cae1e43679199ab9d0c529069f5cf5cc..39bb24f496e455eeb8801d880c5e17c1779a09fc 100644 (file)
--- a/src/java/org/apache/fop/apps/Document.java
+++ b/src/java/org/apache/fop/apps/Document.java
@@ -95,10 +95,9 @@ public class Document implements FOTreeControl, FOTreeListener {
      */
     private LayoutStrategy layoutStrategy = null;
 
-    /**
-     * The current AreaTree for the PageSequence being rendered.
-     */
+    /** The current AreaTree for the PageSequence being rendered. */
     public AreaTree areaTree;
+    /** The AreaTreeModel for the PageSequence being rendered. */
     public AreaTreeModel atModel;
 
     private Bookmarks bookmarks = null;
@@ -350,10 +349,19 @@ public class Document implements FOTreeControl, FOTreeListener {
         return areaTree;
     }
 
+    /**
+     * Set the Bookmarks object for this Document
+     * @param bookmarks the Bookmarks object containing the bookmarks for this
+     * Document
+     */
     public void setBookmarks(Bookmarks bookmarks) {
         this.bookmarks = bookmarks;
     }
 
+    /**
+     * Public accessor for the Bookmarks for this Document
+     * @return the Bookmarks for this Document
+     */
     public Bookmarks getBookmarks() {
         return bookmarks;
     }

diff --git a/src/java/org/apache/fop/apps/FOPException.java b/src/java/org/apache/fop/apps/FOPException.java
index f90a75272be917ddef26910ce41e1a5e08b49385..fed3b9d5c50c82a1131439e189e12b17d75c1345 100644 (file)
--- a/src/java/org/apache/fop/apps/FOPException.java
+++ b/src/java/org/apache/fop/apps/FOPException.java
@@ -105,6 +105,10 @@ public class FOPException extends Exception {
         return exception;
     }
 
+    /**
+     * Attempts to recast the exception as other Throwable types.
+     * @return the exception recast as another type if possible, otherwise null.
+     */
     protected Throwable getRootException() {
         Throwable result = exception;
 

diff --git a/src/java/org/apache/fop/apps/FOUserAgent.java b/src/java/org/apache/fop/apps/FOUserAgent.java
index cbd0ba9781f3d46edbcc2c7789f88d57df95a171..15d10e7afdf384f05f761a972ed625e1e0197da5 100644 (file)
--- a/src/java/org/apache/fop/apps/FOUserAgent.java
+++ b/src/java/org/apache/fop/apps/FOUserAgent.java
@@ -85,7 +85,9 @@ import org.apache.fop.pdf.PDFEncryptionParams;
 public class FOUserAgent implements LogEnabled {
 
     private Logger log;
+    /** Map containing various default values */
     public Map defaults = new java.util.HashMap();
+    /** Map containing XML handlers for various document types */
     public Map handlers = new java.util.HashMap();
     private String baseURL;
     private PDFEncryptionParams pdfEncryptionParams;

diff --git a/src/java/org/apache/fop/apps/InputHandler.java b/src/java/org/apache/fop/apps/InputHandler.java
index 02d90aa4d2ec1c9ad2526a02851811a4478b6af7..0f7df38bca81006c886c6bb3d883f9ef9a83068d 100644 (file)
--- a/src/java/org/apache/fop/apps/InputHandler.java
+++ b/src/java/org/apache/fop/apps/InputHandler.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,22 +42,19 @@
  * (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.apps;
 
 // SAX
 import org.xml.sax.InputSource;
 import org.xml.sax.XMLReader;
-import org.xml.sax.SAXException;
 
 // Java
-import javax.xml.parsers.SAXParserFactory;
-import javax.xml.parsers.ParserConfigurationException;
 import java.net.URL;
 import java.io.File;
 
@@ -111,6 +108,6 @@ public abstract class InputHandler {
             throw new Error("unexpected MalformedURLException");
         }
     }
-    
+
 }