Fixed all javadoc issues, "ant javadocs" now works without errors

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

diff --git a/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java b/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
index 2c60cf4bf2e851b91dcac72e723b38acf6fafb8d..9534ef8adcebfebdbd2430e6e92245a39fbd5657 100644 (file)
--- a/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
+++ b/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
@@ -52,7 +52,6 @@ public class DefaultFontConfigurator implements FontConfigurator<EmbedFontInfo>
 
     /**
      * Main constructor
-     * @param fontInfoConfig the configuration object
      * @param fontManager the font manager
      * @param listener the font event listener
      * @param strict true if an Exception should be thrown if an error is found.

diff --git a/src/java/org/apache/fop/fonts/FontCache.java b/src/java/org/apache/fop/fonts/FontCache.java
index 35997f3d705c322585184dec19ace2ee0168f043..8eceda3277c86bc09c8859c1bb185dc2bcef7123 100644 (file)
--- a/src/java/org/apache/fop/fonts/FontCache.java
+++ b/src/java/org/apache/fop/fonts/FontCache.java
@@ -462,10 +462,9 @@ public final class FontCache implements Serializable {
     }
 
     /**
-     * Retrieve the last modified date/time of a URL.
+     * Retrieve the last modified date/time of a URI.
      *
-     * @param url
-     *            the URL
+     * @param uri the URI
      * @return the last modified date/time
      */
     public static long getLastModified(URI uri) {

diff --git a/src/java/org/apache/fop/fonts/FontManager.java b/src/java/org/apache/fop/fonts/FontManager.java
index e9b02197845365136d6a272802178b856374f7a6..bff001f73daa2412518fb72fb0d5c6f3968f21e3 100644 (file)
--- a/src/java/org/apache/fop/fonts/FontManager.java
+++ b/src/java/org/apache/fop/fonts/FontManager.java
@@ -138,7 +138,6 @@ public class FontManager {
 
     /**
      * Whether or not to cache results of font triplet detection/auto-config
-     * @param useCache use cache or not
      */
     public void disableFontCache() {
         fontCacheManager = FontCacheManagerFactory.createDisabled();
@@ -163,8 +162,7 @@ public class FontManager {
 
     /**
      * Deletes the current FontCache file
-     * @return Returns true if the font cache file was successfully deleted.
-     * @throws FOPException -
+     * @throws FOPException if an error was thrown while deleting the cache
      */
     public void deleteCache() throws FOPException {
         fontCacheManager.delete(getCacheFile(true));

diff --git a/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java b/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
index bcf7b1b619300c2a5fd9473f347edb983997e3be..cad6fd3cf3937326fab7ba6405e3832b9a4ed07f 100644 (file)
--- a/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
+++ b/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
@@ -136,7 +136,7 @@ public abstract class AbstractPageNumberCitationLayoutManager extends LeafNodeLa
 
     /**
      * @return {@link org.apache.fop.area.inline.UnresolvedPageNumber#FIRST} or
-     * {@linkorg.apache.fop.area.inline.UnresolvedPageNumber#LAST}
+     * {@link org.apache.fop.area.inline.UnresolvedPageNumber#LAST}
      */
     protected abstract boolean getReferenceType();
 

diff --git a/src/java/org/apache/fop/pdf/StreamCacheFactory.java b/src/java/org/apache/fop/pdf/StreamCacheFactory.java
index aa4d665daa4e71fd4a388a3a66135d59f7f1ba22..e81edf62a7373a33b9638a53c2a16559e68334ff 100644 (file)
--- a/src/java/org/apache/fop/pdf/StreamCacheFactory.java
+++ b/src/java/org/apache/fop/pdf/StreamCacheFactory.java
@@ -30,7 +30,6 @@ public final class StreamCacheFactory {
 
     /**
      * Returns an instance of a StreamCacheFactory with the requested features.
-     * @param cacheToFile True if file shall be cached using a temporary file
      * @return StreamCacheFactory the requested factory
      */
     public static StreamCacheFactory getInstance() {

diff --git a/src/java/org/apache/fop/render/AbstractRendererMaker.java b/src/java/org/apache/fop/render/AbstractRendererMaker.java
index b4a281efa732f5d50a1474d0a50c738db3996718..505a60a1c1749c3f85fbc5dd9bdde298cd7ca440 100644 (file)
--- a/src/java/org/apache/fop/render/AbstractRendererMaker.java
+++ b/src/java/org/apache/fop/render/AbstractRendererMaker.java
@@ -46,10 +46,10 @@ public abstract class AbstractRendererMaker {
     public abstract String[] getSupportedMimeTypes();
 
     /**
-     * Returns a renderer config object that can be used to
-     * configure the renderer.
+     * Configures a given renderer using the appropriate configurator.
+     *
      * @param userAgent user agent
-     * @return a config object that can be used to configure the renderer
+     * @param renderer the renderer that is to be configured
      */
     public abstract void configureRenderer(FOUserAgent userAgent, Renderer renderer)
             throws FOPException;

diff --git a/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java b/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
index c00ebe29e26c2917268d95b8245c2bfaf6918603..a55f42e9d8aad1935509b3268688c6468b08c43c 100644 (file)
--- a/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
+++ b/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
@@ -29,6 +29,7 @@ public interface IFDocumentHandlerConfigurator {
 
     /**
      * Configures a intermediate format document handler.
+     *
      * @param documentHandler the document handler instance
      * @throws FOPException if an error occurs while configuring the object
      */
@@ -36,10 +37,10 @@ public interface IFDocumentHandlerConfigurator {
 
     /**
      * Sets up the {@link FontInfo} object for the IFDocumentHandler.
-     * @param documentHandler the document handler instance
+     *
+     * @param mimeType the MIME type of the document handler
      * @param fontInfo the font info object to set up
      * @throws FOPException if an error occurs while configuring the object
      */
     void setupFontInfo(String mimeType, FontInfo fontInfo) throws FOPException;
-
 }

diff --git a/src/java/org/apache/fop/render/ps/PSRendererOption.java b/src/java/org/apache/fop/render/ps/PSRendererOption.java
index 4c339692161c4def76f2de224332ff14c76f7f02..992ca19594e8d2cb032eb5215852826cfdab112d 100644 (file)
--- a/src/java/org/apache/fop/render/ps/PSRendererOption.java
+++ b/src/java/org/apache/fop/render/ps/PSRendererOption.java
@@ -29,7 +29,7 @@ import org.apache.fop.render.RendererConfigOption;
 public enum PSRendererOption implements RendererConfigOption {
     /** Indicates whether landscape pages should be rotated, default: false */
     AUTO_ROTATE_LANDSCAPE("auto-rotate-landscape", false),
-    /** Sets the PostScript language leven, default: {@see PSGenerator#DEFAULT_LANGUAGE_LEVEL}*/
+    /** Sets the PostScript language level, default: {@link PSGenerator#DEFAULT_LANGUAGE_LEVEL} */
     LANGUAGE_LEVEL("language-level", PSGenerator.DEFAULT_LANGUAGE_LEVEL),
     /** Whether resources should be optimized in a post-processing run, default: false */
     OPTIMIZE_RESOURCES("optimize-resources", false),

diff --git a/src/java/org/apache/fop/util/ColorSpaceCache.java b/src/java/org/apache/fop/util/ColorSpaceCache.java
index a249fe47beda36f9ddc3a655f24107014bf15697..acb83cdef831adeeb820e6948bb4b9162aec581d 100644 (file)
--- a/src/java/org/apache/fop/util/ColorSpaceCache.java
+++ b/src/java/org/apache/fop/util/ColorSpaceCache.java
@@ -62,13 +62,11 @@ public class ColorSpaceCache {
      * If that fails null is returned.
      *
      * @param profileName the profile name
-     * @param base a base URI to resolve relative URIs
-     * @param iccProfileSrc ICC Profile source to return a ColorSpace for
+     * @param iccProfileSrc ICC Profile source to return a ColorSpace
      * @param renderingIntent overriding rendering intent
      * @return ICC ColorSpace object or null if ColorSpace could not be created
      */
-    public ColorSpace get(String profileName, String iccProfileSrc,
-            RenderingIntent renderingIntent) {
+    public ColorSpace get(String profileName, String iccProfileSrc, RenderingIntent renderingIntent) {
         String key = profileName + ":" + iccProfileSrc;
         // TODO: This stuff needs some TLC, fix it!!
         ColorSpace colorSpace = null;