maven-doxia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vsive...@apache.org
Subject svn commit: r746998 - in /maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer: ./ pdf/ pdf/fo/ pdf/itext/
Date Mon, 23 Feb 2009 12:52:19 GMT
Author: vsiveton
Date: Mon Feb 23 12:52:18 2009
New Revision: 746998

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

Modified:
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
    maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
Mon Feb 23 12:52:18 2009
@@ -54,6 +54,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractDocumentRenderer
     extends AbstractLogEnabled
@@ -79,11 +80,8 @@
      *
      * @param filesToProcess the Map of Files to process. The Map should contain as keys
the paths of the
      *      source files (relative to {@link #getBaseDir() baseDir}), and the corresponding
SiteModule as values.
-     *
      * @param outputDirectory the output directory where the document should be generated.
-     *
      * @param documentModel the document model, containing all the metadata, etc.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
      * @throws java.io.IOException if any
      */
@@ -114,9 +112,7 @@
      *
      * @param baseDirectory the directory containing the source files.
      *              This should follow the standard Maven convention, ie containing all the
site modules.
-     *
      * @param outputDirectory the output directory where the document should be generated.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
      * @throws java.io.IOException if any
      */
@@ -131,12 +127,9 @@
      *
      * @param baseDirectory the directory containing the source files.
      *              This should follow the standard Maven convention, ie containing all the
site modules.
-     *
      * @param outputDirectory the output directory where the document should be generated.
-     *
      * @param documentDescriptor a file containing the document model.
      *              If this file does not exist or is null, some default settings will be
used.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
      * @throws java.io.IOException if any
      */

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
Mon Feb 23 12:52:18 2009
@@ -31,6 +31,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public interface DocumentRenderer
 {
@@ -42,13 +43,10 @@
      *
      * @param files the path name Strings (relative to a common base directory)
      *              of files to include in the document generation.
-     *
      * @param outputDirectory the output directory where the document should be generated.
-     *
      * @param documentModel the document model, containing all the metadata, etc.
      *              If the model contains a TOC, only the files found in this TOC are rendered,
      *              otherwise all files from the Collection of files will be processed.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.
      * @throws java.io.IOException if any.
      */
@@ -60,13 +58,10 @@
      *
      * @param baseDirectory the directory containing the source files.
      *              This should follow the standard Maven convention, ie containing all the
site modules.
-     *
      * @param outputDirectory the output directory where the document should be generated.
-     *
      * @param documentModel the document model, containing all the metadata, etc.
      *              If the model contains a TOC, only the files found in this TOC are rendered,
      *              otherwise all files found under baseDirectory will be processed.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
      * @throws java.io.IOException if any
      */
@@ -77,9 +72,7 @@
      * Read a document model from a file.
      *
      * @param documentDescriptor a document descriptor file that contains the document model.
-     *
      * @return the document model, containing all the metadata, etc.
-     *
      * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any
      * @throws java.io.IOException if any
      */

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
Mon Feb 23 12:52:18 2009
@@ -24,6 +24,7 @@
  *
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @version $Id$
+ * @since 1.1
  */
 public class DocumentRendererException
     extends Exception

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
Mon Feb 23 12:52:18 2009
@@ -26,6 +26,7 @@
  *
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public abstract class AbstractPdfRenderer
     extends AbstractDocumentRenderer

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
Mon Feb 23 12:52:18 2009
@@ -29,19 +29,20 @@
  *
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public interface PdfRenderer extends DocumentRenderer
 {
     /** Plexus lookup role. */
     String ROLE = PdfRenderer.class.getName();
 
-    /**
-     * Generate a final pdf ouput file from an intermediate format file.
-     *
+   /**
+    * Generate a final pdf ouput file from an intermediate format file.
+    *
      * @param inputFile eg a fo or an itext file.
      * @param pdfFile the pdf file to generate.
-     * @throws DocumentRendererException if any.
-     */
+     * @throws org.apache.maven.doxia.docrenderer.DocumentRendererException if any.
+    */
    void generatePdf( File inputFile, File pdfFile )
         throws DocumentRendererException;
 }

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
Mon Feb 23 12:52:18 2009
@@ -44,6 +44,7 @@
  *
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public class FoPdfRenderer
     extends AbstractPdfRenderer

Modified: maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java?rev=746998&r1=746997&r2=746998&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
(original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
Mon Feb 23 12:52:18 2009
@@ -64,6 +64,7 @@
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
  * @author ltheussl
  * @version $Id$
+ * @since 1.1
  */
 public class ITextPdfRenderer
     extends AbstractPdfRenderer



Mime
View raw message