You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2007/10/07 14:55:26 UTC
svn commit: r582622 - in
/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc:
AbstractJavadocMojo.java JavadocJar.java JavadocReport.java
Author: vsiveton
Date: Sun Oct 7 05:55:26 2007
New Revision: 582622
URL: http://svn.apache.org/viewvc?rev=582622&view=rev
Log:
o added several @since tag
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java?rev=582622&r1=582621&r2=582622&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/AbstractJavadocMojo.java Sun Oct 7 05:55:26 2007
@@ -78,6 +78,7 @@
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id$
+ * @since 2.0
* @requiresDependencyResolution compile
* @aggregator
*/
@@ -100,6 +101,7 @@
* For Javadoc options appears since Java 1.4.
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.html#summary">
* What's New in Javadoc 1.4</a>
+ * @since 2.1
*/
private static final float SINCE_JAVADOC_1_4 = 1.4f;
@@ -107,6 +109,7 @@
* For Javadoc options appears since Java 1.4.2.
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">
* What's New in Javadoc 1.4.2</a>
+ * @since 2.1
*/
private static final float SINCE_JAVADOC_1_4_2 = 1.42f;
@@ -114,6 +117,7 @@
* For Javadoc options appears since Java 5.0.
* See <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">
* What's New in Javadoc 5.0</a>
+ * @since 2.1
*/
private static final float SINCE_JAVADOC_1_5 = 1.5f;
@@ -121,6 +125,7 @@
* For Javadoc options appears since Java 6.0.
* See <a href="http://java.sun.com/javase/6/docs/technotes/guides/javadoc/index.html">
* Javadoc Technology</a>
+ * @since 2.4
*/
private static final float SINCE_JAVADOC_1_6 = 1.6f;
@@ -147,6 +152,8 @@
protected MavenProject project;
/**
+ * Specify if the javadoc should operate in offline mode.
+ *
* @parameter default-value="${settings.offline}"
* @required
* @readonly
@@ -156,6 +163,7 @@
/**
* Specifies the Javadoc ressources directory to be included in the Javadoc (i.e. package.html, images...).
*
+ * @since 2.1
* @parameter expression="${basedir}/src/main/javadoc"
*/
private File javadocDirectory;
@@ -176,6 +184,7 @@
* </pre>
* See <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#J">Jflag</a>.
*
+ * @since 2.3
* @parameter expression="${additionalJOption}"
*/
private String additionalJOption;
@@ -226,6 +235,7 @@
/**
* Used to resolve artifacts of aggregated modules
*
+ * @since 2.1
* @component
*/
private ArtifactMetadataSource artifactMetadataSource;
@@ -233,6 +243,7 @@
/**
* Set this to 'true' to debug Javadoc plugin. With this, 'options' and 'files' files are provided.
*
+ * @since 2.1
* @parameter expression="${debug}" default-value="false"
*/
private boolean debug;
@@ -240,6 +251,7 @@
/**
* Sets the path of the Javadoc Tool executable to use.
*
+ * @since 2.3
* @parameter expression="${javadocExecutable}"
*/
private String javadocExecutable;
@@ -247,6 +259,7 @@
/**
* Version of the Javadoc Tool executable to use, ex. "1.3", "1.5".
*
+ * @since 2.3
* @parameter expression="${javadocVersion}"
*/
private String javadocVersion;
@@ -323,6 +336,7 @@
* </docletArtifacts>
* </pre>
*
+ * @since 2.1
* @parameter expression="${docletArtifacts}"
*/
private DocletArtifact[] docletArtifacts;
@@ -642,6 +656,7 @@
* Since <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">
* Java 5.0</a>.
*
+ * @since 2.1
* @parameter expression="${keywords}" default-value="false"
*/
private boolean keywords;
@@ -773,6 +788,7 @@
* Since <a href="http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html#commandlineoptions">
* Java 5.0</a>.
*
+ * @since 2.1
* @parameter expression="${notimestamp}" default-value="false"
*/
private boolean notimestamp;
@@ -792,6 +808,7 @@
* Since <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/whatsnew-1.4.2.html#commandlineoptions">
* Java 1.4.2</a>.
*
+ * @since 2.1
* @parameter expression="${packagesheader}"
*/
private String packagesheader;
@@ -817,6 +834,7 @@
* <br/>
* Since Java 5.0.
*
+ * @since 2.1
* @parameter expression="${sourcetab}" alias="linksourcetab"
*/
private String sourcetab;
@@ -909,6 +927,7 @@
* </tagletArtifact>
* </pre>
*
+ * @since 2.1
* @parameter expression="${tagletArtifact}"
*/
private TagletArtifact tagletArtifact;
@@ -935,6 +954,7 @@
* </taglets>
* </pre>
*
+ * @since 2.1
* @parameter expression="${taglets}"
*/
private Taglet[] taglets;
@@ -946,6 +966,7 @@
* <br/>
* Since Java 6.0
*
+ * @since 2.4
* @parameter expression="${top}"
*/
private String top;
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java?rev=582622&r1=582621&r2=582622&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java Sun Oct 7 05:55:26 2007
@@ -36,6 +36,8 @@
/**
* Bundles the javadoc documentation in a jar so it can be deployed to the repo.
*
+ * @version $Id$
+ * @since 2.0
* @goal jar
* @phase package
*/
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java?rev=582622&r1=582621&r2=582622&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocReport.java Sun Oct 7 05:55:26 2007
@@ -41,6 +41,7 @@
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id$
+ * @since 2.0
* @goal javadoc
* @phase generate-sources
* @see <a href="http://java.sun.com/j2se/javadoc/">Javadoc Tool</a>
@@ -72,6 +73,7 @@
/**
* The name of the destination directory.
*
+ * @since 2.1
* @parameter expression="${destDir}" default-value="apidocs"
*/
private String destDir;
@@ -79,6 +81,7 @@
/**
* The name of the Javadoc report.
*
+ * @since 2.1
* @parameter expression="${name}" default-value="JavaDocs"
*/
private String name;
@@ -86,6 +89,7 @@
/**
* The description of the Javadoc report.
*
+ * @since 2.1
* @parameter expression="${description}" default-value="JavaDoc API documentation."
*/
private String description;