You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2007/09/05 16:24:19 UTC
svn commit: r572957 - in
/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin:
Book.java DoxiaRenderBooksMojo.java Format.java
Author: ltheussl
Date: Wed Sep 5 07:24:18 2007
New Revision: 572957
URL: http://svn.apache.org/viewvc?rev=572957&view=rev
Log:
Javadocs
Modified:
maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java
maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java
maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java
Modified: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java?rev=572957&r1=572956&r2=572957&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java (original)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java Wed Sep 5 07:24:18 2007
@@ -22,41 +22,73 @@
import java.util.List;
/**
+ * A model for a Book.
+ *
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
* @version $Id$
*/
public class Book
{
+ /** Path to the book descriptor file. */
private String descriptor;
+ /** The list of formats to produce. */
private List formats;
+ /** The base directory of source files. */
private String directory;
+ /** Files to include. */
private List includes;
+ /** Files to exclude. */
private List excludes;
+ /**
+ * Returns the path to the book descriptor file.
+ *
+ * @return the book descriptor file.
+ */
public String getDescriptor()
{
return descriptor;
}
+ /**
+ * Returns the list of {@link Format}s to produce.
+ *
+ * @return the list of formats.
+ */
public List getFormats()
{
return formats;
}
+ /**
+ * Returns the base directory of source files.
+ *
+ * @return the base directory.
+ */
public String getDirectory()
{
return directory;
}
+ /**
+ * Returns the list of files to include.
+ *
+ * @return the list of files to include.
+ */
public List getIncludes()
{
return includes;
}
+ /**
+ * Returns the list of files to exclude.
+ *
+ * @return the list of files to exclude.
+ */
public List getExcludes()
{
return excludes;
Modified: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java?rev=572957&r1=572956&r2=572957&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java (original)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java Wed Sep 5 07:24:18 2007
@@ -36,6 +36,8 @@
import java.util.List;
/**
+ * A Mojo to create books in different output formats.
+ *
* @goal render-books
*
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
@@ -76,12 +78,19 @@
*/
private BookDoxia bookDoxia;
+ /** System EOL. */
private static final String LINE_SEPARATOR = System.getProperty( "line.separator" );
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
+ /**
+ * Executes the Mojo.
+ *
+ * @throws MojoExecutionException if an exception occurs during the execution of the plugin.
+ * @throws MojoFailureException if there are configuration errors.
+ */
public void execute()
throws MojoExecutionException, MojoFailureException
{
@@ -214,6 +223,12 @@
}
}
+ /**
+ * Returns a formatted message of a ValidationResult.
+ *
+ * @param result the ValidationResult to format.
+ * @return the formatted result.
+ */
private String formatResult( ValidationResult result )
{
StringBuffer buffer = new StringBuffer();
Modified: maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java?rev=572957&r1=572956&r2=572957&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java (original)
+++ maven/sandbox/trunk/doxia/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java Wed Sep 5 07:24:18 2007
@@ -20,13 +20,21 @@
*/
/**
+ * A model for a supported output format.
+ *
* @author <a href="mailto:trygve.laugstol@objectware.no">Trygve Laugstøl</a>
* @version $Id$
*/
public class Format
{
+ /** A unique identifier for the format. */
private String id;
+ /**
+ * Returns the (unique) identifier of this format.
+ *
+ * @return the identifier.
+ */
public String getId()
{
return id;