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 vs...@apache.org on 2009/02/23 13:15:43 UTC

svn commit: r746976 - in /maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book: ./ context/ services/indexer/ services/io/ services/renderer/ services/renderer/docbook/ services/renderer/latex/ services/renderer/xhtml/

Author: vsiveton
Date: Mon Feb 23 12:15:38 2009
New Revision: 746976

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

Modified:
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
    maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java Mon Feb 23 12:15:38 2009
@@ -41,7 +41,7 @@
      *
      * @param bookDescriptor the book descriptor file.
      * @return BookModel
-     * @throws BookDoxiaException if the model cannot be loaded.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
      */
     BookModel loadBook( File bookDescriptor )
         throws BookDoxiaException;
@@ -53,7 +53,7 @@
      * @param bookRendererId the id of the output format.
      * @param files a list of source files.
      * @param outputDirectory the output directory.
-     * @throws BookDoxiaException if the model cannot be loaded.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
      * @see {@link #renderBook(BookModel, String, List, File, String, String, String)}
      * @see {@link Locale#getDefault()}
      */
@@ -70,7 +70,7 @@
      * @param locale the wanted locale.
      * @param inputEncoding the input encoding when processing {@link files}.
      * @param outputEncoding the output encoding when writing files in {@link ouputDirectory}.
-     * @throws BookDoxiaException if the model cannot be loaded.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
      */
     void renderBook( BookModel book, String bookRendererId, List files, File outputDirectory, Locale locale,
                      String inputEncoding, String outputEncoding )

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java Mon Feb 23 12:15:38 2009
@@ -191,7 +191,10 @@
     }
 
     /**
+     * <p>Getter for the field <code>locale</code>.</p>
+     *
      * @return the locale
+     * @since 1.1
      */
     public Locale getLocale()
     {
@@ -199,7 +202,10 @@
     }
 
     /**
+     * <p>Setter for the field <code>locale</code>.</p>
+     *
      * @param locale the locale to set
+     * @since 1.1
      */
     public void setLocale( Locale locale )
     {
@@ -207,7 +213,10 @@
     }
 
     /**
+     * <p>Getter for the field <code>inputEncoding</code>.</p>
+     *
      * @return the inputEncoding
+     * @since 1.1
      */
     public String getInputEncoding()
     {
@@ -215,7 +224,10 @@
     }
 
     /**
+     * <p>Setter for the field <code>inputEncoding</code>.</p>
+     *
      * @param inputEncoding the inputEncoding to set
+     * @since 1.1
      */
     public void setInputEncoding( String inputEncoding )
     {
@@ -223,7 +235,10 @@
     }
 
     /**
+     * <p>Getter for the field <code>outputEncoding</code>.</p>
+     *
      * @return the outputEncoding
+     * @since 1.1
      */
     public String getOutputEncoding()
     {
@@ -231,7 +246,10 @@
     }
 
     /**
+     * <p>Setter for the field <code>outputEncoding</code>.</p>
+     *
      * @param outputEncoding the outputEncoding to set
+     * @since 1.1
      */
     public void setOutputEncoding( String outputEncoding )
     {

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java Mon Feb 23 12:15:38 2009
@@ -22,13 +22,17 @@
 import org.apache.maven.doxia.index.IndexEntry;
 
 /**
+ * <p>BookIndex class.</p>
+ *
  * @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */
 public class BookIndex
     extends IndexEntry
 {
-    /** Constructs a new BookIndex. */
+    /**
+     * Constructs a new BookIndex.
+     */
     public BookIndex()
     {
         super( "book" );

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java Mon Feb 23 12:15:38 2009
@@ -39,7 +39,7 @@
      *
      * @param book the book to index.
      * @param bookContext the BookContext.
-     * @throws BookDoxiaException if the book cannot be indexed.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the book cannot be indexed.
      */
     void indexBook( BookModel book, BookContext bookContext )
         throws BookDoxiaException;

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java Mon Feb 23 12:15:38 2009
@@ -42,7 +42,7 @@
      *
      * @param bookDescriptor the book descriptor file.
      * @return BookModel
-     * @throws BookDoxiaException if the model cannot be read.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be read.
      */
     BookModel readBook( File bookDescriptor )
         throws BookDoxiaException;

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java Mon Feb 23 12:15:38 2009
@@ -41,8 +41,9 @@
 import java.util.List;
 
 /**
- * @plexus.component
+ * <p>DefaultBookIo class.</p>
  *
+ * @plexus.component
  * @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java Mon Feb 23 12:15:38 2009
@@ -180,7 +180,7 @@
      *
      * @param iTextFile the input file.
      * @param iTextOutput the output file.
-     * @throws IOException if any.
+     * @throws java.io.IOException if any.
      */
     public abstract void renderXML( File iTextFile, File iTextOutput )
         throws IOException;

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java Mon Feb 23 12:15:38 2009
@@ -37,7 +37,7 @@
      * Render a book.
      *
      * @param context the BookContext.
-     * @throws BookDoxiaException if the book cannot be rendered.
+     * @throws org.apache.maven.doxia.book.BookDoxiaException if the book cannot be rendered.
      */
     void renderBook( BookContext context )
         throws BookDoxiaException;

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java Mon Feb 23 12:15:38 2009
@@ -46,8 +46,8 @@
  * An implementation of <code>BookRenderer</code> for docbook
  *
  * @plexus.component role-hint="doc-book"
- *
  * @author Eric Redmond
+ * @version $Id$
  */
 public class DocbookBookRenderer
     extends AbstractLogEnabled

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java Mon Feb 23 12:15:38 2009
@@ -45,8 +45,9 @@
 import java.util.HashMap;
 
 /**
- * @plexus.component role-hint="latex"
+ * <p>LatexBookRenderer class.</p>
  *
+ * @plexus.component role-hint="latex"
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java Mon Feb 23 12:15:38 2009
@@ -42,8 +42,9 @@
 import java.util.Iterator;
 
 /**
- * @plexus.component role-hint="xhtml"
+ * <p>XHtmlBookRenderer class.</p>
  *
+ * @plexus.component role-hint="xhtml"
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java Mon Feb 23 12:15:38 2009
@@ -33,6 +33,7 @@
  *
  * @author Dave Syer
  * @version $Id$
+ * @since 1.1
  */
 public class DocBookBookSink
     extends DocBookSink
@@ -56,49 +57,81 @@
     //
     // ----------------------------------------------------------------------
 
-    /** Does nothing because we don't want the header from each document to crop up in the middle of a book. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing because we don't want the header from each document to crop up in the middle of a book. 
+     */
     public void head()
     {
         // noop
     }
 
-    /** Does nothing because we don't want the header from each document to crop up in the middle of a book. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing because we don't want the header from each document to crop up in the middle of a book. 
+     */
     public void head_()
     {
         // noop
     }
 
-    /** Marks the skip flag to true so that this element's text is not emitted by the base class. */
+    /**
+     * {@inheritDoc}
+     *
+     * Marks the skip flag to true so that this element's text is not emitted by the base class. 
+     */
     public void title()
     {
         setSkip( true );
     }
 
-    /** Marks the skip flag to false so that rendering can resume. */
+    /**
+     * {@inheritDoc}
+     *
+     * Marks the skip flag to false so that rendering can resume. 
+     */
     public void title_()
     {
         setSkip( false );
     }
 
-    /** Marks the skip flag to true so that this element's text is not emitted by the base class. */
+    /**
+     * {@inheritDoc}
+     *
+     * Marks the skip flag to true so that this element's text is not emitted by the base class. 
+     */
     public void author()
     {
         setSkip( true );
     }
 
-    /** Marks the skip flag to false so that rendering can resume. */
+    /**
+     * {@inheritDoc}
+     *
+     * Marks the skip flag to false so that rendering can resume. 
+     */
     public void author_()
     {
         setSkip( false );
     }
 
-    /** Does nothing because we don't want the header from each document to crop up in the middle of a book. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing because we don't want the header from each document to crop up in the middle of a book. 
+     */
     public void body()
     {
         // noop
     }
 
-    /** Does nothing because we don't want the header from each document to crop up in the middle of a book. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing because we don't want the header from each document to crop up in the middle of a book. 
+     */
     public void body_()
     {
         // noop
@@ -140,7 +173,9 @@
         }
     }
 
-    /** If some header matter has been encountered emit the book info end tag. */
+    /**
+     * If some header matter has been encountered emit the book info end tag.
+     */
     public void bookHead_()
     {
         if ( hasHead )
@@ -150,64 +185,84 @@
         }
     }
 
-    /** Emit the title start tag for the whole book. */
+    /**
+     * Emit the title start tag for the whole book.
+     */
     public void bookTitle()
     {
         bookHead();
         writeStartTag( Tag.TITLE );
     }
 
-    /** Emit the title end tag for the whole book. */
+    /**
+     * Emit the title end tag for the whole book.
+     */
     public void bookTitle_()
     {
         super.title_();
     }
 
-    /** Emit the author start tag for the whole book. */
+    /**
+     * Emit the author start tag for the whole book.
+     */
     public void bookAuthor()
     {
         bookHead();
         super.author();
     }
 
-    /** Emit the author end tag for the whole book. */
+   /**
+    * Emit the author end tag for the whole book.
+    */
    public void bookAuthor_()
     {
         super.author_();
     }
 
-   /** Emit the date start tag for the whole book. */
+   /**
+    * Emit the date start tag for the whole book.
+    */
    public void bookDate()
     {
         bookHead();
         super.date();
     }
 
-   /** Emit the date end tag for the whole book. */
+    /**
+     * Emit the date end tag for the whole book.
+     */
     public void bookDate_()
     {
         super.date_();
     }
 
-    /** Emit the chapter start tag. */
+    /**
+     * Emit the chapter start tag.
+     */
     public void chapter()
     {
         writeStartTag( CHAPTER_TAG );
     }
 
-    /** Emit the chapter end tag. */
+    /**
+     * Emit the chapter end tag.
+     */
     public void chapter_()
     {
         writeEndTag( CHAPTER_TAG );
     }
 
-    /** Emit the chapter title start tag. */
+    /**
+     * Emit the chapter title start tag.
+     */
     public void chapterTitle()
     {
         writeStartTag( Tag.TITLE );
     }
 
-    /** Emit the chapter title end tag. */
+    /**
+     * Emit the chapter title end tag.
+     */
     public void chapterTitle_()
     {
         writeEndTag( Tag.TITLE );

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java Mon Feb 23 12:15:38 2009
@@ -24,6 +24,8 @@
 import java.io.Writer;
 
 /**
+ * <p>LatexBookSink class.</p>
+ *
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id$
  */

Modified: maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java?rev=746976&r1=746975&r2=746976&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java (original)
+++ maven/doxia/doxia/trunk/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java Mon Feb 23 12:15:38 2009
@@ -54,7 +54,11 @@
     //
     // ----------------------------------------------------------------------
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void head()
     {
         resetState();
@@ -62,91 +66,135 @@
         setHeadFlag( true );
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void head_()
     {
         setHeadFlag( false );
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void title()
     {
         // noop
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void title_()
     {
         resetTextBuffer();
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void author_()
     {
         resetTextBuffer();
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void date_()
     {
         resetTextBuffer();
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void body()
     {
         // noop
     }
 
-    /** Does nothing. */
+    /**
+     * {@inheritDoc}
+     *
+     * Does nothing. 
+     */
     public void body_()
     {
         // noop
     }
 
-    /** Calls super.head(). */
+    /**
+     * Calls super.head().
+     */
     public void bookHead()
     {
         super.head();
     }
 
-    /** Calls super.head_(). */
+    /**
+     * Calls super.head_().
+     */
     public void bookHead_()
     {
         super.head_();
     }
 
-    /** Calls super.title(). */
+    /**
+     * Calls super.title().
+     */
     public void bookTitle()
     {
         super.title();
     }
 
-    /** Calls super.title_(). */
+    /**
+     * Calls super.title_().
+     */
     public void bookTitle_()
     {
         super.title_();
     }
 
-    /** Calls super.head_(). */
+    /**
+     * Calls super.head_().
+     */
     public void bookAuthor_()
     {
         super.author_();
     }
 
-    /** Calls super.head_(). */
+    /**
+     * Calls super.head_().
+     */
     public void bookDate_()
     {
         super.date_();
     }
 
-    /**  Calls super.body(). */
+    /**
+     * Calls super.body().
+     */
     public void bookBody()
     {
         super.body();
     }
 
-    /** Calls super.body_(). */
+    /**
+     * Calls super.body_().
+     */
     public void bookBody_()
     {
         super.body_();