maven-doxia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vsive...@apache.org
Subject svn commit: r746978 - in /maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia: index/ macro/ macro/manager/ macro/snippet/ module/site/ module/site/manager/ parser/ parser/manager/ sink/ sink/render/ util/
Date Mon, 23 Feb 2009 12:20:36 GMT
Author: vsiveton
Date: Mon Feb 23 12:20:33 2009
New Revision: 746978

URL: http://svn.apache.org/viewvc?rev=746978&view=rev
Log:
o fix javadoc using javadoc:fix

Modified:
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractBinarySinkFactory.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSinkFactory.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSinkFactory.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/render/RenderingContext.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java
Mon Feb 23 12:20:33 2009
@@ -27,6 +27,8 @@
 import java.util.Collections;
 
 /**
+ * <p>IndexEntry class.</p>
+ *
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */
@@ -260,9 +262,9 @@
     // -----------------------------------------------------------------------
 
     /**
-     * Returns a string representation of the object.
+     * {@inheritDoc}
      *
-     * @return A string.
+     * Returns a string representation of the object.
      */
     public String toString()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
Mon Feb 23 12:20:33 2009
@@ -81,6 +81,8 @@
     }
 
     /**
+     * <p>Getter for the field <code>title</code>.</p>
+     *
      * @return the title
      */
     public String getTitle()
@@ -230,6 +232,8 @@
     }
 
     /**
+     * <p>peek</p>
+     *
      * @return Looks at the IndexEntry at the top of this stack
      */
     public IndexEntry peek()

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java
Mon Feb 23 12:20:33 2009
@@ -47,6 +47,7 @@
      * If no logger has been configured, a new SystemStreamLog is returned.
      *
      * @return Log
+     * @since 1.1
      */
     protected Log getLog()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java
Mon Feb 23 12:20:33 2009
@@ -28,6 +28,7 @@
  * A simple macro that prints out the key and value of some supplied parameters.
  *
  * @plexus.component role-hint="echo"
+ * @version $Id$
  */
 public class EchoMacro
     extends AbstractMacro

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java
Mon Feb 23 12:20:33 2009
@@ -44,7 +44,7 @@
      *
      * @param sink The sink to receive the events.
      * @param request The corresponding MacroRequest.
-     * @throws MacroExecutionException if an error occurred during execution.
+     * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred
during execution.
      */
     void execute( Sink sink, MacroRequest request )
         throws MacroExecutionException;

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java
Mon Feb 23 12:20:33 2009
@@ -23,6 +23,8 @@
 import java.io.File;
 
 /**
+ * <p>MacroRequest class.</p>
+ *
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
  * @version $Id$
  * @since 1.0

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java
Mon Feb 23 12:20:33 2009
@@ -38,7 +38,7 @@
      *
      * @param id The identifier.
      * @return The corresponding MacroManager.
-     * @throws MacroNotFoundException if no MacroManager could be found
+     * @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if no MacroManager
could be found
      * for the given id.
      */
     Macro getMacro( String id )

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java
Mon Feb 23 12:20:33 2009
@@ -37,6 +37,7 @@
  * A macro that prints out the content of a file or a URL.
  *
  * @plexus.component role-hint="snippet"
+ * @version $Id$
  */
 public class SnippetMacro
     extends AbstractMacro

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
Mon Feb 23 12:20:33 2009
@@ -30,7 +30,11 @@
 
 import org.codehaus.plexus.util.IOUtil;
 
-/** Utility class for reading snippets. */
+/**
+ * Utility class for reading snippets.
+ *
+ * @version $Id$
+ */
 public class SnippetReader
 {
     /** System-dependent EOL. */
@@ -54,7 +58,7 @@
      *
      * @param snippetId The id of the snippet.
      * @return The snippet.
-     * @throws IOException if something goes wrong.
+     * @throws java.io.IOException if something goes wrong.
      */
     public StringBuffer readSnippet( String snippetId )
         throws IOException

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java
Mon Feb 23 12:20:33 2009
@@ -31,19 +31,22 @@
     /** The Plexus lookup role. */
     String ROLE = SiteModule.class.getName();
 
-    /** Returns the directory that contains source files for a given module.
+    /**
+     * Returns the directory that contains source files for a given module.
      *
      * @return The source directory.
      */
     String getSourceDirectory();
 
-    /** Returns the default file extension for a given module.
+    /**
+     * Returns the default file extension for a given module.
      *
      * @return The default file extension.
      */
     String getExtension();
 
-    /** Returns the parser id for a given module.
+    /**
+     * Returns the parser id for a given module.
      *
      * @return The parser id.
      */

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java
Mon Feb 23 12:20:33 2009
@@ -47,7 +47,7 @@
      *
      * @param id The identifier.
      * @return The corresponding SiteModule.
-     * @throws SiteModuleNotFoundException if no SiteModule could be found
+     * @throws org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException if
no SiteModule could be found
      * for the given id.
      */
     SiteModule getSiteModule( String id )

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
Mon Feb 23 12:20:33 2009
@@ -64,8 +64,8 @@
      * @param macroId An id to lookup the macro.
      * @param request The corresponding MacroRequest.
      * @param sink The sink to receive the events.
-     * @throws MacroExecutionException if an error occurred during execution.
-     * @throws MacroNotFoundException if the macro could not be found.
+     * @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred
during execution.
+     * @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if the macro could
not be found.
      */
     // Made public right now because of the structure of the APT parser and
     // all its inner classes.
@@ -103,7 +103,7 @@
      *
      * @param string A string that provides the source input.
      * @param sink A sink that consumes the Doxia events.
-     * @throws ParseException if the string could not be parsed.
+     * @throws org.apache.maven.doxia.parser.ParseException if the string could not be parsed.
      */
     public void parse( String string, Sink sink )
         throws ParseException
@@ -125,6 +125,7 @@
      * Indicates if we are currently parsing a second time.
      *
      * @return true if we are currently parsing a second time.
+     * @since 1.1
      */
     protected boolean isSecondParsing()
     {
@@ -142,6 +143,7 @@
      * If no logger has been configured yet, a new SystemStreamLog is returned.
      *
      * @return Log
+     * @since 1.1
      */
     protected Log getLog()
     {
@@ -157,6 +159,7 @@
      * Gets the current {@link MacroManager}.
      *
      * @return The current {@link MacroManager}.
+     * @since 1.1
      */
     protected MacroManager getMacroManager()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
Mon Feb 23 12:20:33 2009
@@ -148,12 +148,9 @@
     }
 
     /**
-     * Convenience method to parse an arbitrary string and emit any xml events into the given
sink.
+     * {@inheritDoc}
      *
-     * @param string A string that provides the source input. The string has to be completely
-     * enclosed inside one xml root element, otherwise a ParseException is thrown.
-     * @param sink A sink that consumes the Doxia events.
-     * @throws ParseException if the string does not represent a well-formed xml snippet.
+     * Convenience method to parse an arbitrary string and emit any xml events into the given
sink.
      */
     public void parse( String string, Sink sink )
         throws ParseException
@@ -172,6 +169,7 @@
      *
      * @param parser A parser, not null.
      * @return a SinkEventAttributeSet or null if the current parser event is not a start
tag.
+     * @since 1.1
      */
     protected SinkEventAttributeSet getAttributesFromParser( XmlPullParser parser )
     {
@@ -337,8 +335,11 @@
         throws XmlPullParserException;
 
     /**
+     * <p>isIgnorableWhitespace</p>
+     *
      * @return <code>true</code> if whitespace will be ignored, <code>false</code>
otherwise.
      * @see #setIgnorableWhitespace(boolean)
+     * @since 1.1
      */
     protected boolean isIgnorableWhitespace()
     {
@@ -352,6 +353,7 @@
      * <pre>&lt;tr&gt;&lt;td/&gt;&lt;/tr&gt;</pre>
      *
      * @param ignorable <code>true</code> to ignore whitespace, <code>false</code>
otherwise.
+     * @since 1.1
      */
     protected void setIgnorableWhitespace( boolean ignorable )
     {
@@ -359,8 +361,11 @@
     }
 
     /**
+     * <p>isCollapsibleWhitespace</p>
+     *
      * @return <code>true</code> if text will collapse, <code>false</code>
otherwise.
      * @see #setCollapsibleWhitespace(boolean)
+     * @since 1.1
      */
     protected boolean isCollapsibleWhitespace()
     {
@@ -374,6 +379,7 @@
      * <pre>Text Text</pre>
      *
      * @param collapsible <code>true</code> to allow collapsible text, <code>false</code>
otherwise.
+     * @since 1.1
      */
     protected void setCollapsibleWhitespace( boolean collapsible )
     {
@@ -381,8 +387,11 @@
     }
 
     /**
+     * <p>isTrimmableWhitespace</p>
+     *
      * @return <code>true</code> if text will be trim, <code>false</code>
otherwise.
      * @see #setTrimmableWhitespace(boolean)
+     * @since 1.1
      */
     protected boolean isTrimmableWhitespace()
     {
@@ -396,6 +405,7 @@
      * <pre>&lt;p&gt;Text&lt;/p&gt;</pre>
      *
      * @param trimmable <code>true</code> to allow trimmable text, <code>false</code>
otherwise.
+     * @since 1.1
      */
     protected void setTrimmableWhitespace( boolean trimmable )
     {
@@ -403,11 +413,14 @@
     }
 
     /**
+     * <p>getText</p>
+     *
      * @param parser A parser, not null.
      * @return the {@link XmlPullParser#getText()} taking care of trimmable or collapsible
configuration.
      * @see XmlPullParser#getText()
      * @see #isCollapsibleWhitespace()
      * @see #isTrimmableWhitespace()
+     * @since 1.1
      */
     protected String getText( XmlPullParser parser )
     {
@@ -446,6 +459,7 @@
      * </pre>
      *
      * @return a map of the defined entities in a local doctype.
+     * @since 1.1
      */
     protected Map getLocalEntities()
     {
@@ -458,7 +472,10 @@
     }
 
     /**
+     * <p>isValidate</p>
+     *
      * @return <code>true</code> if XML content will be validate, <code>false</code>
otherwise.
+     * @since 1.1
      */
     public boolean isValidate()
     {
@@ -470,6 +487,7 @@
      *
      * @param validate the validate to set
      * @see #parse(Reader, Sink)
+     * @since 1.1
      */
     public void setValidate( boolean validate )
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java
Mon Feb 23 12:20:33 2009
@@ -192,6 +192,8 @@
     }
 
     /**
+     * <p>Getter for the field <code>fileName</code>.</p>
+     *
      * @return the file name that caused the <code>ParseException</code>.
      */
     public String getFileName()
@@ -200,6 +202,8 @@
     }
 
     /**
+     * <p>Getter for the field <code>lineNumber</code>.</p>
+     *
      * @return the line number where the <code>ParseException</code> occurred.
      */
     public int getLineNumber()
@@ -208,7 +212,10 @@
     }
 
     /**
+     * <p>Getter for the field <code>columnNumber</code>.</p>
+     *
      * @return the column number where the <code>ParseException</code> occurred.
+     * @since 1.1
      */
     public int getColumnNumber()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java
Mon Feb 23 12:20:33 2009
@@ -54,7 +54,7 @@
      * @param source not null reader that provides the source document.
      * You could use <code>newReader</code> methods from {@link org.codehaus.plexus.util.ReaderFactory}.
      * @param sink A sink that consumes the Doxia events.
-     * @throws ParseException if the model could not be parsed.
+     * @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed.
      */
     void parse( Reader source, Sink sink )
         throws ParseException;

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java
Mon Feb 23 12:20:33 2009
@@ -39,7 +39,7 @@
      */
     private Map parsers;
 
-   /** {@inheritDoc} */
+    /** {@inheritDoc} */
     public Parser getParser( String id )
         throws ParserNotFoundException
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java
Mon Feb 23 12:20:33 2009
@@ -38,7 +38,7 @@
      *
      * @param id The identifier.
      * @return The corresponding parser.
-     * @throws ParserNotFoundException if no parser could be found
+     * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException if no parser
could be found
      * for the given id.
      */
     Parser getParser( String id )

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractBinarySinkFactory.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractBinarySinkFactory.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractBinarySinkFactory.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractBinarySinkFactory.java
Mon Feb 23 12:20:33 2009
@@ -31,6 +31,7 @@
  *
  * @author <a href="mailto:hboutemy@apache.org">Hervé Boutemy</a>
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractBinarySinkFactory
     implements SinkFactory

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractSink.java
Mon Feb 23 12:20:33 2009
@@ -47,6 +47,7 @@
      * If no logger has been configured, a new SystemStreamLog is returned.
      *
      * @return Log
+     * @since 1.1
      */
     protected Log getLog()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSink.java
Mon Feb 23 12:20:33 2009
@@ -26,6 +26,7 @@
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractTextSink
     extends SinkAdapter

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSinkFactory.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSinkFactory.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSinkFactory.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractTextSinkFactory.java
Mon Feb 23 12:20:33 2009
@@ -34,6 +34,7 @@
  * @author Hervé Boutemy
  * @author Benjamin Bentmann
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractTextSinkFactory
     implements SinkFactory

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java
Mon Feb 23 12:20:33 2009
@@ -42,6 +42,7 @@
      * Sets the default namespace that is prepended to all tags written by this sink.
      *
      * @param ns the default namespace.
+     * @since 1.1
      */
     public void setNameSpace( String ns )
     {
@@ -52,6 +53,7 @@
      * Return the default namespace that is prepended to all tags written by this sink.
      *
      * @return the current default namespace.
+     * @since 1.1
      */
     public String getNameSpace()
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSinkFactory.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSinkFactory.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSinkFactory.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSinkFactory.java
Mon Feb 23 12:20:33 2009
@@ -27,6 +27,7 @@
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractXmlSinkFactory
     extends AbstractTextSinkFactory

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/PipelineSink.java
Mon Feb 23 12:20:33 2009
@@ -58,13 +58,9 @@
     }
 
     /**
-     * Invoke a Method on this PipelineSink.
+     * {@inheritDoc}
      *
-     * @param proxy the proxy instance that the method was invoked on. Unused.
-     * @param method the Method to invoke.
-     * @param args an array of arguments to the Method.
-     * @return always returns null.
-     * @throws java.lang.Throwable the Exception to throw from the Method invocation.
+     * Invoke a Method on this PipelineSink.
      */
     public Object invoke( Object proxy, Method method, Object[] args )
         throws Throwable
@@ -83,7 +79,7 @@
      * Returns an instance of a PipelineSink as a Sink.
      *
      * @param pipeline A List of Sinks.
-     * @return
+     * @return a {@link org.apache.maven.doxia.sink.Sink} object.
      */
     public static Sink newInstance( List pipeline )
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java
Mon Feb 23 12:20:33 2009
@@ -256,10 +256,9 @@
     }
 
     /**
-     * Adds an attribute with the given name and value.
+     * {@inheritDoc}
      *
-     * @param name the name.
-     * @param value the value.
+     * Adds an attribute with the given name and value.
      */
     public void addAttribute( Object name, Object value )
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java
Mon Feb 23 12:20:33 2009
@@ -125,6 +125,8 @@
     }
 
     /**
+     * <p>Setter for the field <code>headFlag</code>.</p>
+     *
      * @param headFlag an header flag.
      */
     protected void setHeadFlag( boolean headFlag )
@@ -133,6 +135,8 @@
     }
 
     /**
+     * <p>isHeadFlag</p>
+     *
      * @return the current headFlag.
      */
     protected boolean isHeadFlag()
@@ -141,6 +145,8 @@
     }
 
     /**
+     * <p>Setter for the field <code>verbatimFlag</code>.</p>
+     *
      * @param verb a verbatim flag.
      */
     protected void setVerbatimFlag( boolean verb )
@@ -149,6 +155,8 @@
     }
 
     /**
+     * <p>isVerbatimFlag</p>
+     *
      * @return the current verbatim flag.
      */
     protected boolean isVerbatimFlag()
@@ -157,6 +165,8 @@
     }
 
     /**
+     * <p>Setter for the field <code>cellJustif</code>.</p>
+     *
      * @param justif the new cell justification array.
      */
     protected void setCellJustif( int[] justif )
@@ -166,6 +176,8 @@
     }
 
     /**
+     * <p>Getter for the field <code>cellJustif</code>.</p>
+     *
      * @return the current cell justification array.
      */
     protected int[] getCellJustif()
@@ -174,6 +186,8 @@
     }
 
     /**
+     * <p>Setter for the field <code>cellCount</code>.</p>
+     *
      * @param count the new cell count.
      */
     protected void setCellCount( int count )
@@ -182,6 +196,8 @@
     }
 
     /**
+     * <p>Getter for the field <code>cellCount</code>.</p>
+     *
      * @return the current cell count.
      */
     protected int getCellCount()
@@ -227,11 +243,13 @@
         onSectionTitle( level, attributes );
     }
 
+    /** {@inheritDoc} */
     public void sectionTitle_( int level )
     {
         onSectionTitle_( level );
     }
 
+    /** {@inheritDoc} */
     public void section_( int level )
     {
         onSection_( level );
@@ -801,7 +819,8 @@
         figureCaptionFlag = false;
     }
 
-    /** {@inheritDoc}
+    /**
+     * {@inheritDoc}
      * @deprecated Use {@link #figureGraphics(String,SinkEventAttributes)},
      * this method is only kept for backward compatibility. Note that the behavior is
      * different though, as this method does not write the img tag, only the src attribute.
@@ -842,7 +861,8 @@
         }
     }
 
-    /** {@inheritDoc}
+    /**
+     * {@inheritDoc}
      * @deprecated Use {@link #figureCaption(SinkEventAttributes)},
      * this method is only kept for backward compatibility. Note that the behavior is
      * different though, as this method only writes an alt attribute.
@@ -1660,6 +1680,7 @@
         }
     }
 
+    /** {@inheritDoc} */
     public void text( String text, SinkEventAttributes attributes )
     {
         if ( attributes == null )
@@ -1727,16 +1748,11 @@
     }
 
     /**
+     * {@inheritDoc}
+     *
      * Adding an unkown event, <i>ie</i> an event that was not recognized by
a parser.
      * If {@link org.apache.maven.doxia.util.HtmlTools#getHtmlTag(String) HtmlTools.getHtmlTag(
name )}
      * does not return null, the corresponding tag will be written.
-     *
-     * @param name The name of the event.
-     * @param requiredParams If <code>name</code> is a defined HTML tag, the
first element of
-     * this array has to be an Integer wrapping one of the TAG_TYPE constants in
-     * {@link org.apache.maven.doxia.markup.HtmlMarkup HtmlMarkup}, otherwise an
-     * IllegalArgumentException is thrown.
-     * @param attributes A set of optional {@link SinkEventAttributes}, may be <code>null</code>.
      */
     public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes
)
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/render/RenderingContext.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/render/RenderingContext.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/render/RenderingContext.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/sink/render/RenderingContext.java
Mon Feb 23 12:20:33 2009
@@ -27,6 +27,8 @@
 import java.util.Map;
 
 /**
+ * <p>RenderingContext class.</p>
+ *
  * @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
  * @version $Id$
  * @since 1.0
@@ -47,17 +49,38 @@
 
     private Map attributes;
 
+    /**
+     * <p>Constructor for RenderingContext.</p>
+     *
+     * @param basedir a {@link java.io.File} object.
+     * @param document a {@link java.lang.String} object.
+     */
     public RenderingContext( File basedir, String document )
     {
         this( basedir, document, null );
     }
 
+    /**
+     * <p>Constructor for RenderingContext.</p>
+     *
+     * @param basedir a {@link java.io.File} object.
+     * @param document a {@link java.lang.String} object.
+     * @param parserId a {@link java.lang.String} object.
+     */
     public RenderingContext( File basedir, String document, String parserId )
     {
         this( basedir, document, null, null );
 
     }
 
+    /**
+     * <p>Constructor for RenderingContext.</p>
+     *
+     * @param basedir a {@link java.io.File} object.
+     * @param document a {@link java.lang.String} object.
+     * @param parserId a {@link java.lang.String} object.
+     * @param extension a {@link java.lang.String} object.
+     */
     public RenderingContext( File basedir, String document, String parserId, String extension
)
     {
         this.basedir = basedir;
@@ -85,41 +108,83 @@
         this.attributes = new HashMap();
     }
 
+    /**
+     * <p>Getter for the field <code>basedir</code>.</p>
+     *
+     * @return a {@link java.io.File} object.
+     */
     public File getBasedir()
     {
         return basedir;
     }
 
+    /**
+     * <p>Getter for the field <code>inputName</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getInputName()
     {
         return inputName;
     }
 
+    /**
+     * <p>Getter for the field <code>outputName</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getOutputName()
     {
         return outputName;
     }
 
+    /**
+     * <p>Getter for the field <code>parserId</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getParserId()
     {
         return parserId;
     }
 
+    /**
+     * <p>Getter for the field <code>relativePath</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getRelativePath()
     {
         return relativePath;
     }
 
+    /**
+     * <p>setAttribute</p>
+     *
+     * @param key a {@link java.lang.String} object.
+     * @param value a {@link java.lang.String} object.
+     */
     public void setAttribute( String key, String value )
     {
         attributes.put( key, value );
     }
 
+    /**
+     * <p>getAttribute</p>
+     *
+     * @param key a {@link java.lang.String} object.
+     * @return a {@link java.lang.String} object.
+     */
     public String getAttribute( String key )
     {
         return (String) attributes.get( key );
     }
 
+    /**
+     * <p>Getter for the field <code>extension</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getExtension()
     {
         return extension;

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java
Mon Feb 23 12:20:33 2009
@@ -33,6 +33,8 @@
 
 /**
  * {@link ByLineSource} default implementation
+ *
+ * @version $Id$
  */
 public class ByLineReaderSource implements ByLineSource
 {
@@ -150,4 +152,4 @@
             lastLine = s;
         }
     }
-}
\ No newline at end of file
+}

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java
Mon Feb 23 12:20:33 2009
@@ -26,26 +26,35 @@
  *
  * @author Juan F. Codagnone
  * @since Nov 4, 2005
+ * @version $Id$
  */
 public interface ByLineSource
 {
     /**
+     * <p>getNextLine</p>
+     *
      * @return the next line. <code>null</code> if we reached the end.
      * @throws org.apache.maven.doxia.parser.ParseException on I/O error
      */
     String getNextLine() throws ParseException;
 
     /**
+     * <p>getName</p>
+     *
      * @return the name of the input. could be the filename for example
      */
     String getName();
 
     /**
+     * <p>getLineNumber</p>
+     *
      * @return the current line number
      */
     int getLineNumber();
 
     /**
+     * <p>ungetLine</p>
+     *
      * @throws java.lang.IllegalStateException if the ungetLine/unget is called more than
      *                               one time without calling getNextLine()
      */
@@ -53,6 +62,8 @@
 
 
     /**
+     * <p>unget</p>
+     *
      * @param s some text to push back to the parser
      * @throws java.lang.IllegalStateException if the ungetLine/unget is called more than
      *                               one time without calling getNextLine()

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
Mon Feb 23 12:20:33 2009
@@ -79,6 +79,7 @@
      * @return a tag constant corresponding to the <code>tagName</code>,
      *    or <code>null</code> if not found.
      * @see <a href="http://www.w3.org/TR/html401/index/elements.html">http://www.w3.org/TR/html401/index/elements.html</a>
+     * @since 1.1
      */
     public static Tag getHtmlTag( String tagName )
     {

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java?rev=746978&r1=746977&r2=746978&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
(original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java
Mon Feb 23 12:20:33 2009
@@ -25,7 +25,11 @@
 import java.io.IOException;
 import java.io.Writer;
 
-/** Allows to specify the line-length of an output writer. */
+/**
+ * Allows to specify the line-length of an output writer.
+ *
+ * @version $Id$
+ */
 public class LineBreaker
 {
     /** The default maximal line length. */
@@ -91,7 +95,7 @@
      * Writes the given text to the writer. White space is not preserved.
      *
      * @param text The text to write.
-     * @throws IOException if there's a problem writing the text.
+     * @throws java.io.IOException if there's a problem writing the text.
      */
     public void write( String text )
         throws IOException
@@ -202,7 +206,9 @@
         }
     }
 
-    /** Close the writer. */
+    /**
+     * Close the writer.
+     */
     public void close()
     {
         IOUtil.close( writer );



Mime
View raw message