org.apache.maven.plugins.javadoc

Class JavadocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

AggregatorJavadocReport, JavadocNoForkReport, TestJavadocReport

@Mojo(name="javadoc",
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
 @Execute(phase=GENERATE_SOURCES)
public class JavadocReport
extends AbstractJavadocMojo
implements org.apache.maven.reporting.MavenReport

Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.

Since:

2.0

Version:

$Id: JavadocReport.java 1800564 2017-07-02 14:08:18Z michaelo $

See Also:

Javadoc Tool, Javadoc Options

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e.
private java.lang.String	destDir The name of the destination directory.
private java.lang.String	name The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e.
private java.io.File	reportOutputDirectory Specifies the destination directory where javadoc saves the generated HTML files.

Fields inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
JavadocReport()

Method Summary

Modifier and Type

Method and Description

boolean

canGenerateReport() The logic is the following: isAggregator hasSourceFiles isRootProject Generate Report True True True True True True False False True False True False True False False False False True True True False True False True False False True False False False False False void doExecute() void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) private java.util.ResourceBundle getBundle(java.util.Locale locale) Gets the resource bundle for the specified locale. java.lang.String getCategoryName() java.lang.String getDescription(java.util.Locale locale) java.lang.String getName(java.util.Locale locale) java.lang.String getOutputName() java.io.File getReportOutputDirectory() boolean isExternalReport() void setDestDir(java.lang.String theDestDir) void setReportOutputDirectory(java.io.File reportOutputDirectory) Method to set the directory where the generated reports will be put private void updateReportOutputDirectory(java.io.File reportOutputDirectory, java.lang.String destDir) Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter Methods inherited from class org.apache.maven.plugin.AbstractMojo getLog, getPluginContext, setLog, setPluginContext Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Field Detail reportOutputDirectory @Parameter(property="reportOutputDirectory", defaultValue="${project.reporting.outputDirectory}/apidocs", required=true) private java.io.File reportOutputDirectory Specifies the destination directory where javadoc saves the generated HTML files. destDir @Parameter(property="destDir", defaultValue="apidocs") private java.lang.String destDir The name of the destination directory. Since: 2.1 name @Parameter(property="name") private java.lang.String name The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). Since: 2.1 description @Parameter(property="description") private java.lang.String description The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html). Since: 2.1 Constructor Detail JavadocReport public JavadocReport() Method Detail getName public java.lang.String getName(java.util.Locale locale) Specified by: getName in interface org.apache.maven.reporting.MavenReport getDescription public java.lang.String getDescription(java.util.Locale locale) Specified by: getDescription in interface org.apache.maven.reporting.MavenReport generate public void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException Specified by: generate in interface org.apache.maven.reporting.MavenReport Throws: org.apache.maven.reporting.MavenReportException getOutputName public java.lang.String getOutputName() Specified by: getOutputName in interface org.apache.maven.reporting.MavenReport isExternalReport public boolean isExternalReport() Specified by: isExternalReport in interface org.apache.maven.reporting.MavenReport canGenerateReport public boolean canGenerateReport() The logic is the following: isAggregator hasSourceFiles isRootProject Generate Report True True True True True True False False True False True False True False False False False True True True False True False True False False True False False False False False Specified by: canGenerateReport in interface org.apache.maven.reporting.MavenReport getCategoryName public java.lang.String getCategoryName() Specified by: getCategoryName in interface org.apache.maven.reporting.MavenReport getReportOutputDirectory public java.io.File getReportOutputDirectory() Specified by: getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport setReportOutputDirectory public void setReportOutputDirectory(java.io.File reportOutputDirectory) Method to set the directory where the generated reports will be put Specified by: setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport Parameters: reportOutputDirectory - the directory file to be set setDestDir public void setDestDir(java.lang.String theDestDir) Parameters: theDestDir - The destiation directory. updateReportOutputDirectory private void updateReportOutputDirectory(java.io.File reportOutputDirectory, java.lang.String destDir) doExecute public void doExecute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException Specified by: doExecute in class AbstractJavadocMojo Throws: org.apache.maven.plugin.MojoExecutionException org.apache.maven.plugin.MojoFailureException getBundle private java.util.ResourceBundle getBundle(java.util.Locale locale) Gets the resource bundle for the specified locale. Parameters: locale - The locale of the currently generated report. Returns: The resource bundle for the requested locale. Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method