From 1e21dd0309e887005fb73eeb32e334111759aca7 Mon Sep 17 00:00:00 2001 From: Mehdi Houshmand Date: Mon, 23 Jul 2012 10:21:23 +0000 Subject: [PATCH] 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 --- src/java/org/apache/fop/fonts/DefaultFontConfigurator.java | 1 - src/java/org/apache/fop/fonts/FontCache.java | 5 ++--- src/java/org/apache/fop/fonts/FontManager.java | 4 +--- .../inline/AbstractPageNumberCitationLayoutManager.java | 2 +- src/java/org/apache/fop/pdf/StreamCacheFactory.java | 1 - src/java/org/apache/fop/render/AbstractRendererMaker.java | 6 +++--- .../render/intermediate/IFDocumentHandlerConfigurator.java | 5 +++-- src/java/org/apache/fop/render/ps/PSRendererOption.java | 2 +- src/java/org/apache/fop/util/ColorSpaceCache.java | 6 ++---- 9 files changed, 13 insertions(+), 19 deletions(-) diff --git a/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java b/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java index 2c60cf4bf..9534ef8ad 100644 --- 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 /** * 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 35997f3d7..8eceda327 100644 --- 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 e9b021978..bff001f73 100644 --- 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 bcf7b1b61..cad6fd3cf 100644 --- 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 aa4d665da..e81edf62a 100644 --- 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 b4a281efa..505a60a1c 100644 --- 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 c00ebe29e..a55f42e9d 100644 --- 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 4c3396921..992ca1959 100644 --- 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 a249fe47b..acb83cdef 100644 --- 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; -- 2.39.5