You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-commits@maven.apache.org by hb...@apache.org on 2008/10/31 22:51:48 UTC

svn commit: r709579 - /maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java

Author: hboutemy
Date: Fri Oct 31 14:51:47 2008
New Revision: 709579

URL: http://svn.apache.org/viewvc?rev=709579&view=rev
Log:
improved javadoc

Modified:
    maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java

Modified: maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java?rev=709579&r1=709578&r2=709579&view=diff
==============================================================================
--- maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java (original)
+++ maven/doxia/doxia-tools/trunk/doxia-converter/src/main/java/org/apache/maven/doxia/util/ConverterUtil.java Fri Oct 31 14:51:47 2008
@@ -40,10 +40,10 @@
      * @param plexus not null
      * @param format not null
      * @param supportedFormats not null
-     * @return an instance of <code>Parser</code> depending the format.
+     * @return an instance of <code>Parser</code> depending on the format.
      * @throws ComponentLookupException if could not find the Parser for the given format.
      * @throws UnsupportedFormatException if the found parser is not instantiated.
-     * @throws IllegalArgumentException if parameters are null
+     * @throws IllegalArgumentException if any parameter is null
      */
     public static Parser getParser( PlexusContainer plexus, String format, String[] supportedFormats )
         throws ComponentLookupException, UnsupportedFormatException
@@ -83,10 +83,10 @@
      * @param format not null
      * @param writer could be null
      * @param supportedFormats not null
-     * @return an instance of <code>Sink</code> depending the given format.
+     * @return an instance of <code>Sink</code> depending on the given format.
      * @throws ComponentLookupException if could not find the SinkFactory for the given format.
-     * @throws UnsupportedFormatException if the found parser is not instantiated.
-     * @throws IllegalArgumentException if parameters are null
+     * @throws UnsupportedFormatException if the found sink is not instantiated.
+     * @throws IllegalArgumentException if any parameter is null
      */
     public static Sink getSink( PlexusContainer plexus, String format, Writer writer, String[] supportedFormats )
         throws ComponentLookupException, UnsupportedFormatException