You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by oc...@apache.org on 2006/05/22 13:04:24 UTC
svn commit: r408641 - in
/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc:
DocletArtifact.java JavadocJar.java JavadocReport.java OfflineLink.java
Author: oching
Date: Mon May 22 04:04:23 2006
New Revision: 408641
URL: http://svn.apache.org/viewvc?rev=408641&view=rev
Log:
PR: MJAVADOC-71
Added javadoc tags.
Modified:
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/DocletArtifact.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
maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/OfflineLink.java
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/DocletArtifact.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/DocletArtifact.java?rev=408641&r1=408640&r2=408641&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/DocletArtifact.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/DocletArtifact.java Mon May 22 04:04:23 2006
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * This class represents the doclet artifact parameter specified in the plugin configuration.
+ */
public class DocletArtifact
{
private String groupId;
@@ -24,31 +27,61 @@
private String version;
+ /**
+ * Method to get the groupId of the artifact
+ *
+ * @return a String that contains the groupId
+ */
public String getGroupId()
{
return groupId;
}
+ /**
+ * Method to set the groupId of the artifact
+ *
+ * @param groupId the value to be set
+ */
public void setGroupId( String groupId )
{
this.groupId = groupId;
}
+ /**
+ * Method to get the artifactId of the artifact
+ *
+ * @return a String that contains the artifactId
+ */
public String getArtifactId()
{
return artifactId;
}
+ /**
+ * Method to set the artifactId of the artifact
+ *
+ * @param artifactId the value to be set
+ */
public void setArtifactId( String artifactId )
{
this.artifactId = artifactId;
}
+ /**
+ * Method to get the version of the artifact
+ *
+ * @return a String that contains the version
+ */
public String getVersion()
{
return version;
}
+ /**
+ * Method to set the version of the artifact
+ *
+ * @param version the value to be set
+ */
public void setVersion( String version )
{
this.version = version;
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=408641&r1=408640&r2=408641&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 Mon May 22 04:04:23 2006
@@ -46,11 +46,16 @@
private File destDir;
/**
+ * Specifies the directory where the generated jar file will be put.
+ *
* @parameter expression="${project.build.directory}"
*/
private String jarOutputDirectory;
/**
+ * Specified the filename that will be used for the generated jar file. Please note that "-javadoc"
+ * will be appended to the file name.
+ *
* @parameter expression="${project.build.finalName}"
*/
private String finalName;
@@ -61,10 +66,15 @@
private MavenProjectHelper projectHelper;
/**
+ * Specifies whether to attach the generated artifact to the project helper.
+ *
* @parameter expression="${attach}" default-value="true"
*/
private boolean attach;
+ /**
+ * @see org.apache.maven.reporting.AbstractMavenReport#execute()
+ */
public void execute()
throws MojoExecutionException
{
@@ -121,6 +131,15 @@
}
}
+ /**
+ * Method that creates the jar file
+ *
+ * @param javadocFiles the directory where the generated jar file will be put
+ * @param target the filename of the generated jar file
+ * @return a File object that contains the generated jar file
+ * @throws ArchiverException
+ * @throws IOException
+ */
private File generateArchive( File javadocFiles, String target )
throws ArchiverException, IOException
{
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=408641&r1=408640&r2=408641&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 Mon May 22 04:04:23 2006
@@ -112,11 +112,17 @@
return "apidocs/index";
}
+ /**
+ * @see org.apache.maven.reporting.MavenReport#isExternalReport()
+ */
public boolean isExternalReport()
{
return true;
}
+ /**
+ * @see org.apache.maven.reporting.MavenReport#canGenerateReport()
+ */
public boolean canGenerateReport()
{
boolean canGenerate;
@@ -135,11 +141,17 @@
return canGenerate;
}
+ /**
+ * @see org.apache.maven.reporting.MavenReport#getCategoryName()
+ */
public String getCategoryName()
{
return CATEGORY_PROJECT_REPORTS;
}
+ /**
+ * @see org.apache.maven.reporting.MavenReport#getReportOutputDirectory()
+ */
public File getReportOutputDirectory()
{
if ( reportOutputDirectory == null )
@@ -149,11 +161,19 @@
return reportOutputDirectory;
}
+ /**
+ * Method to set the directory where the generated reports will be put
+ *
+ * @param reportOutputDirectory the directory file to be set
+ */
public void setReportOutputDirectory( File reportOutputDirectory )
{
this.reportOutputDirectory = reportOutputDirectory;
}
+ /**
+ * @see org.apache.maven.reporting.AbstractMavenReport#execute()
+ */
public void execute()
throws MojoExecutionException, MojoFailureException
{
Modified: maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/OfflineLink.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/OfflineLink.java?rev=408641&r1=408640&r2=408641&view=diff
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/OfflineLink.java (original)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/OfflineLink.java Mon May 22 04:04:23 2006
@@ -18,27 +18,50 @@
import java.io.File;
+/**
+ * This class represents an offline link parameter specfied in the plugin configuration.
+ */
public class OfflineLink
{
private String url;
private File location;
+ /**
+ * Method to get the url of the link
+ *
+ * @return a String that contains the url
+ */
public String getUrl()
{
return url;
}
+ /**
+ * Method to set the url of the link
+ *
+ * @param url the value to be set
+ */
public void setUrl( String url )
{
this.url = url;
}
+ /**
+ * Method to get the location of the link
+ *
+ * @return a String that contains the url
+ */
public File getLocation()
{
return location;
}
+ /**
+ * Method to set the location of the link
+ *
+ * @param location the value to be set
+ */
public void setLocation( File location )
{
this.location = location;