Glenn,

Is it worth porting these javadoc amendments to the 1.1 branch? I don't
mind doing it if you'd like them in 1.1.

Mehdi

On 23 July 2012 11:21, <me...@apache.org> wrote:

> Author: mehdi
> Date: Mon Jul 23 10:21:23 2012
> New Revision: 1364567
>
> URL: http://svn.apache.org/viewvc?rev=1364567&view=rev
> Log:
> Fixed all javadoc issues, "ant javadocs" now works without errors
>
> Modified:
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
>     xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontCache.java
>     xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontManager.java
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/pdf/StreamCacheFactory.java
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/AbstractRendererMaker.java
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
>
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/ps/PSRendererOption.java
>     xmlgraphics/fop/trunk/src/java/org/apache/fop/util/ColorSpaceCache.java
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/DefaultFontConfigurator.java
> Mon Jul 23 10:21:23 2012
> @@ -52,7 +52,6 @@ public class DefaultFontConfigurator imp
>
>      /**
>       * 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.
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontCache.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontCache.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> --- xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontCache.java
> (original)
> +++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontCache.java Mon
> Jul 23 10:21:23 2012
> @@ -462,10 +462,9 @@ public final class FontCache implements
>      }
>
>      /**
> -     * 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) {
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontManager.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontManager.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> --- xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontManager.java
> (original)
> +++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fonts/FontManager.java
> Mon Jul 23 10:21:23 2012
> @@ -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));
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/layoutmgr/inline/AbstractPageNumberCitationLayoutManager.java
> Mon Jul 23 10:21:23 2012
> @@ -136,7 +136,7 @@ public abstract class AbstractPageNumber
>
>      /**
>       * @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();
>
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/pdf/StreamCacheFactory.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/pdf/StreamCacheFactory.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/pdf/StreamCacheFactory.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/pdf/StreamCacheFactory.java
> Mon Jul 23 10:21:23 2012
> @@ -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() {
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/AbstractRendererMaker.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/AbstractRendererMaker.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/AbstractRendererMaker.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/AbstractRendererMaker.java
> Mon Jul 23 10:21:23 2012
> @@ -46,10 +46,10 @@ public abstract class AbstractRendererMa
>      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;
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/intermediate/IFDocumentHandlerConfigurator.java
> Mon Jul 23 10:21:23 2012
> @@ -29,6 +29,7 @@ public interface IFDocumentHandlerConfig
>
>      /**
>       * 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 IFDocumentHandlerConfig
>
>      /**
>       * 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;
> -
>  }
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/ps/PSRendererOption.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/render/ps/PSRendererOption.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/ps/PSRendererOption.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/render/ps/PSRendererOption.java
> Mon Jul 23 10:21:23 2012
> @@ -29,7 +29,7 @@ import org.apache.fop.render.RendererCon
>  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),
>
> Modified:
> xmlgraphics/fop/trunk/src/java/org/apache/fop/util/ColorSpaceCache.java
> URL:
> http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/util/ColorSpaceCache.java?rev=1364567&r1=1364566&r2=1364567&view=diff
>
> ==============================================================================
> ---
> xmlgraphics/fop/trunk/src/java/org/apache/fop/util/ColorSpaceCache.java
> (original)
> +++
> xmlgraphics/fop/trunk/src/java/org/apache/fop/util/ColorSpaceCache.java Mon
> Jul 23 10:21:23 2012
> @@ -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;
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: fop-commits-unsubscr...@xmlgraphics.apache.org
> For additional commands, e-mail: fop-commits-h...@xmlgraphics.apache.org
>
>

Reply via email to