]> source.dussan.org Git - xmlgraphics-fop.git/commitdiff
javadoc changes to clean up gump warnings.
authorWilliam Victor Mote <vmote@apache.org>
Thu, 24 Apr 2003 02:48:08 +0000 (02:48 +0000)
committerWilliam Victor Mote <vmote@apache.org>
Thu, 24 Apr 2003 02:48:08 +0000 (02:48 +0000)
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196335 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/fop/datatypes/Keep.java
src/java/org/apache/fop/fonts/truetype/TTFFile.java
src/java/org/apache/fop/image/XMLImage.java
src/java/org/apache/fop/layout/hyphenation/TernaryTree.java
src/java/org/apache/fop/pdf/PDFDocument.java
src/java/org/apache/fop/pdf/package.html
src/java/org/apache/fop/render/AbstractRenderer.java
src/java/org/apache/fop/render/package.html
src/java/org/apache/fop/render/pdf/package.html
src/java/org/apache/fop/render/xml/package.html

index ac363ebf24ee35a6201632b955b1bef15888683b..996708b8868cdb4c3f81fe64ebb6607e91ce4942 100644 (file)
@@ -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
  * (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.datatypes;
 
 import org.apache.fop.fo.Property;
@@ -114,7 +114,7 @@ public class Keep implements CompoundDatatype {
     }
 
     /**
-     * What to do here?? There isn't really a meaningful single value.
+     * Not sure what to do here. There isn't really a meaningful single value.
      */
     public String toString() {
         return "Keep";
index 157d0d569980ef9f1d0f74f86b7aa1a1dbd1729a..0490bdf033cf079d846afdbd35f76c572170dede 100644 (file)
@@ -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
  * (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.fonts.truetype;
 
 import java.io.IOException;
@@ -129,7 +129,7 @@ public class TTFFile extends AbstractLogEnabled {
 
     private int ansiWidth[];
     private Map ansiIndex;
-    
+
     private TTFDirTabEntry currentDirTab;
 
     /**
@@ -745,8 +745,8 @@ public class TTFFile extends AbstractLogEnabled {
 
     /**
      * Read the "hhea" table to find the ascender and descender and
-     * size of "hmtx" table, i.e. a fixed size font might have only
-     * one width
+     * size of "hmtx" table, as a fixed size font might have only
+     * one width.
      * @param in FontFileReader to read the hhea table from
      * @throws IOException in case of an I/O problem
      */
@@ -841,12 +841,12 @@ public class TTFFile extends AbstractLogEnabled {
         case 0x00020000:
             getLogger().debug("PostScript format 2");
             int numGlyphStrings = 0;
-            
+
             // Read Number of Glyphs
-            int l = in.readTTFUShort();      
-            
+            int l = in.readTTFUShort();
+
             // Read indexes
-            for (int i = 0; i < l; i++) {    
+            for (int i = 0; i < l; i++) {
                 mtxTab[i].setIndex(in.readTTFUShort());
 
                 if (mtxTab[i].getIndex() > 257) {
@@ -858,7 +858,7 @@ public class TTFFile extends AbstractLogEnabled {
                     getLogger().debug("PostScript index: " + mtxTab[i].getIndexAsString());
                 }
             }
-            
+
             // firstChar=minIndex;
             String[] psGlyphsBuffer = new String[numGlyphStrings];
             if (getLogger().isDebugEnabled()) {
index 8f655bb232c6800a8778a09a619f0e9755b72e02..a1a7b8b926f8a275e82262f0867a34a58c53084e 100644 (file)
@@ -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
  * (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.image;
 
 // Java
@@ -58,17 +58,17 @@ import org.apache.fop.apps.Driver;
 
 /**
  * This is an implementation for XML-based images such as SVG.
- * 
+ *
  * @see AbstractFopImage
  * @see FopImage
  */
 public class XMLImage extends AbstractFopImage {
-    
+
     private Document doc;
     private String namespace = "";
 
     /**
-     * @see org.apache.fop.image.AbstractFopImage#AbstractFopImage(ImageInfo)
+     * @see org.apache.fop.image.AbstractFopImage#AbstractFopImage(FopImage.ImageInfo)
      */
     public XMLImage(FopImage.ImageInfo imgInfo) {
         super(imgInfo);
index 28d91071cac958860083d57f443136e9dd831230..1670ee290d01e313779c9ce22dddf41e3624aa7f 100644 (file)
@@ -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
  * (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.layout.hyphenation;
 
 import java.util.Enumeration;
@@ -55,7 +55,7 @@ import java.util.Stack;
 import java.io.Serializable;
 
 /**
- * <h2>Ternary Search Tree</h2>
+ * <h2>Ternary Search Tree.</h2>
  *
  * <p>A ternary search tree is a hibrid between a binary tree and
  * a digital search tree (trie). Keys are limited to strings.
index 54f2b420b86034cda486553cd71fc866d68862d0..7047b781311f312ea832a453d11c3dac193861a6 100644 (file)
@@ -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
  * (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.pdf;
 
 // Java
@@ -88,7 +88,7 @@ import org.apache.avalon.framework.logger.Logger;
  *
  */
 public class PDFDocument implements LogEnabled {
-    
+
     private static final Integer LOCATION_PLACEHOLDER = new Integer(0);
     /**
      * the version of PDF supported which is 1.4
@@ -234,11 +234,11 @@ public class PDFDocument implements LogEnabled {
 
 
     private PDFFactory factory;
-    
+
     private boolean encodingOnTheFly = true;
 
     /**
-     * creates an empty PDF document <p>
+     * Creates an empty PDF document.
      *
      * The constructor creates a /Root and /Pages object to
      * track the document but does not write these objects until
@@ -293,7 +293,7 @@ public class PDFDocument implements LogEnabled {
 
     /**
      * Helper method to allow sub-classes to aquire logger.
-     * 
+     *
      * <p>There is no performance penalty as this is a final method
      * and will be inlined by the JVM.</p>
      * @return the Logger
@@ -312,7 +312,7 @@ public class PDFDocument implements LogEnabled {
             return text.getBytes(ENCODING);
         } catch (UnsupportedEncodingException uee) {
             return text.getBytes();
-        }       
+        }
     }
 
     /**
@@ -378,7 +378,7 @@ public class PDFDocument implements LogEnabled {
     }
 
     /**
-     * Registers a PDFObject in this PDF document. The PDF is assigned a new 
+     * Registers a PDFObject in this PDF document. The PDF is assigned a new
      * object number.
      * @param obj PDFObject to add
      * @return PDFObject the PDFObject added (its object number set)
@@ -390,7 +390,7 @@ public class PDFDocument implements LogEnabled {
     }
 
     /**
-     * Assigns the PDFObject a object number and sets the parent of the 
+     * Assigns the PDFObject a object number and sets the parent of the
      * PDFObject to this PDFDocument.
      * @param obj PDFObject to assign a number to
      */
@@ -407,7 +407,7 @@ public class PDFDocument implements LogEnabled {
             throw new IllegalStateException("Error registering a PDFObject: "
                 + "PDFObject already has a parent PDFDocument");
         }
-        
+
         obj.setObjectNumber(++this.objectcount);
 
         if (currentParent == null) {
@@ -431,9 +431,9 @@ public class PDFDocument implements LogEnabled {
 
         //Add object to list
         this.objects.add(obj);
-        
+
         //System.out.println("Registering: "+obj);
-        
+
         //Add object to special lists where necessary
         if (obj instanceof PDFFunction) {
             this.functions.add(obj);
@@ -460,7 +460,7 @@ public class PDFDocument implements LogEnabled {
         }
         if (obj instanceof PDFLink) {
             this.links.add(obj);
-        }            
+        }
         if (obj instanceof PDFFileSpec) {
             this.filespecs.add(obj);
         }
@@ -478,10 +478,10 @@ public class PDFDocument implements LogEnabled {
      */
     public void addTrailerObject(PDFObject obj) {
         this.trailerObjects.add(obj);
-        
+
         if (obj instanceof PDFGoTo) {
             this.gotos.add(obj);
-        }            
+        }
     }
 
     /**
@@ -509,8 +509,8 @@ public class PDFDocument implements LogEnabled {
                 + "generated without encryption.");
         }
     }
-    
-    
+
+
     /**
      * Indicates whether encryption is active for this PDF or not.
      * @return boolean True if encryption is active
@@ -518,7 +518,7 @@ public class PDFDocument implements LogEnabled {
     public boolean isEncryptionActive() {
         return this.encryption != null;
     }
-    
+
     /**
      * Returns the active Encryption object.
      * @return the Encryption object
@@ -613,7 +613,7 @@ public class PDFDocument implements LogEnabled {
     protected PDFGoTo findGoTo(PDFGoTo compare) {
         return (PDFGoTo)findPDFObject(gotos, compare);
     }
-    
+
     /**
      * Looks for an existing GState to use
      * @param wanted requested features
@@ -680,7 +680,7 @@ public class PDFDocument implements LogEnabled {
      * @throws java.io.FileNotFoundException if the URI could not be resolved
      * @return the InputStream from the URI.
      */
-    protected InputStream resolveURI(String uri) 
+    protected InputStream resolveURI(String uri)
                 throws java.io.FileNotFoundException {
         try {
             /**@todo Temporary hack to compile, improve later */
@@ -738,12 +738,12 @@ public class PDFDocument implements LogEnabled {
         return xObject;
     }
 
-    /** 
+    /**
      * Add a form XObject to the PDF document.
      * This adds a Form XObject to the PDF objects.
      * If a Form XObject with the same key already exists it will return the
      * old PDFFormXObject.
-     *  
+     *
      * @param res the PDF resource context to add to, may be null
      * @param cont the PDF Stream contents of the Form XObject
      * @param formres the PDF Resources for the Form XObject data
@@ -833,7 +833,7 @@ public class PDFDocument implements LogEnabled {
     }
 
     /**
-     * write the PDF header <P>
+     * Write the PDF header.
      *
      * This method must be called prior to formatting
      * and outputting AreaTrees.
@@ -886,8 +886,8 @@ public class PDFDocument implements LogEnabled {
         /* construct the trailer */
         String pdf = "trailer\n" + "<<\n"
                      + "/Size " + (this.objectcount + 1) + "\n"
-                     + "/Root " + this.root.referencePDF() + "\n" 
-                     + "/Info " + this.info.referencePDF() + "\n" 
+                     + "/Root " + this.root.referencePDF() + "\n"
+                     + "/Info " + this.info.referencePDF() + "\n"
                      + encryptEntry
                      + ">>\n" + "startxref\n" + this.xref
                      + "\n" + "%%EOF\n";
index 1fd09411dd3f850d10e73a322cf743f5b9517ba9..e86318adc941ea0543844b4adf250bcc784cfa66 100644 (file)
@@ -1,7 +1,7 @@
 <HTML>
 <TITLE>org.apache.fop.pdf Package</TITLE>
 <BODY>
-<P>Classes for handling the low-level creation of PDF documents</P>
+<P>Classes for handling the low-level creation of PDF documents.</P>
 <P>These classes were developed for FOP, but could be used by other
 applications wishing to produce PDF.</P>
 </BODY>
index 65cab8d6bf53668ca82841192cb0807a33ba4816..871bd62aaa6d1c3e4c0225f8c015f2fd05c26c40 100644 (file)
@@ -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
  * (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.render;
 
 // Java
@@ -176,7 +176,7 @@ public abstract class AbstractRenderer extends AbstractLogEnabled
     }
 
     /**
-     * @param ext  @todo Description of the Parameter
+     * @param ext  <todo> Description of the Parameter
      * @see        org.apache.fop.render.Renderer
      */
     public void renderExtension(TreeExt ext) { }
@@ -293,7 +293,7 @@ public abstract class AbstractRenderer extends AbstractLogEnabled
     }
 
     /**
-     * @todo Description of the Method
+     * <todo> Description of the Method
      *
      * @param ctm  The coordinate transformation matrix to use
      */
@@ -311,7 +311,7 @@ public abstract class AbstractRenderer extends AbstractLogEnabled
     }
 
     /**
-     * @todo Description of the Method
+     * <todo> Description of the Method
      */
     protected void endVParea() { }
 
@@ -550,7 +550,7 @@ public abstract class AbstractRenderer extends AbstractLogEnabled
      *
      * @param image  The image
      * @param pos    The target position of the image
-     * @todo Make renderImage() protected
+     * <todo> Make renderImage() protected
      */
     public void renderImage(Image image, Rectangle2D pos) {
         // Default: do nothing.
@@ -576,7 +576,7 @@ public abstract class AbstractRenderer extends AbstractLogEnabled
      *
      * @param fo   The foreign object area
      * @param pos  The target position of the foreign object
-     * @todo Make renderForeignObject() protected
+     * <todo> Make renderForeignObject() protected
      */
     public void renderForeignObject(ForeignObject fo, Rectangle2D pos) {
         // Default: do nothing.
index 25daa021eb80c765e505d346bb66c2494d4afb0c..22671f05457e0f1c5d4880b15441d25204533bda 100644 (file)
@@ -1,6 +1,6 @@
 <HTML>
 <TITLE>org.apache.fop.render Package</TITLE>
 <BODY>
-<P>generic renderer interface</P>
+<P>Generic renderer interface.</P>
 </BODY>
 </HTML>
\ No newline at end of file
index 1bcf2644febc2b6e8aebebac82cd5ad3d9860baa..b7ab755aea27c01949a8e757903589fdd5554e28 100644 (file)
@@ -1,6 +1,6 @@
 <HTML>
 <TITLE>org.apache.fop.render.pdf Package</TITLE>
 <BODY>
-<P>classes for rendering to PDF</P>
+<P>Classes for rendering to PDF.</P>
 </BODY>
 </HTML>
\ No newline at end of file
index ecabe354740f0700f44a06f7b1851a5a2b286585..a25cabaa8deb1785ac8632fb3f192c8fed8b7b92 100644 (file)
@@ -1,6 +1,6 @@
 <HTML>
 <TITLE>org.apache.fop.render.xml Package</TITLE>
 <BODY>
-<P>classes for rendering to XML for debugging</P>
+<P>Classes for rendering to XML for debugging.</P>
 </BODY>
 </HTML>
\ No newline at end of file