@Mojo(name="javadoc", requiresDependencyResolution=COMPILE, threadSafe=true) @Execute(phase=GENERATE_SOURCES) public class JavadocReport extends AbstractJavadocMojo implements MavenReport
Java code
in an NON aggregator project using the standard
Javadoc Tool.aggregate, ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Constructor and Description |
---|
JavadocReport() |
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 |
execute() |
void |
generate(Sink sink,
Locale locale) |
String |
getCategoryName() |
String |
getDescription(Locale locale) |
String |
getName(Locale locale) |
String |
getOutputName() |
File |
getReportOutputDirectory() |
protected boolean |
isAggregator()
Indicates whether this goal is flagged with
@aggregator . |
boolean |
isExternalReport() |
void |
setDestDir(String theDestDir) |
void |
setReportOutputDirectory(File reportOutputDirectory)
Method to set the directory where the generated reports will be put
|
buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, failOnError, getAttachmentClassifier, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, isTest, isValidJavadocLink, logError, resolveDependency
getLog, getPluginContext, setLog, setPluginContext
public String getName(Locale locale)
getName
in interface MavenReport
public String getDescription(Locale locale)
getDescription
in interface MavenReport
public void generate(Sink sink, Locale locale) throws MavenReportException
generate
in interface MavenReport
MavenReportException
public String getOutputName()
getOutputName
in interface MavenReport
public boolean isExternalReport()
isExternalReport
in interface MavenReport
public boolean canGenerateReport()
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 |
canGenerateReport
in interface MavenReport
public String getCategoryName()
getCategoryName
in interface MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface MavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface MavenReport
reportOutputDirectory
- the directory file to be setpublic void setDestDir(String theDestDir)
theDestDir
- The destiation directory.public void execute() throws MojoExecutionException, MojoFailureException
execute
in interface Mojo
MojoExecutionException
MojoFailureException
protected boolean isAggregator()
AbstractJavadocMojo
@aggregator
.isAggregator
in class AbstractJavadocMojo
true
if the goal is designed as an aggregator, false
otherwise.AggregatorJavadocReport
,
AggregatorTestJavadocReport
Copyright © 2004–2016 The Apache Software Foundation. All rights reserved.