|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.javadoc.AbstractJavadocMojo
public abstract class AbstractJavadocMojo
Base class with majority of Javadoc functionalities.
Field Summary | |
---|---|
protected boolean |
aggregate
Whether to build an aggregated report at the root, or build individual reports. |
protected java.io.File |
outputDirectory
Specifies the destination directory where javadoc saves the generated HTML files. |
protected org.apache.maven.project.MavenProject |
project
The Maven Project Object |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractJavadocMojo()
|
Method Summary | |
---|---|
protected boolean |
canGenerateReport(java.util.List files)
Method that indicates whether the javadoc can be generated or not. |
protected void |
executeReport(java.util.Locale locale)
|
protected java.lang.String |
getDoctitle()
|
protected java.util.List |
getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
|
protected java.util.List |
getFiles(java.util.List sourcePaths)
Method to get the files on the specified source paths |
protected java.io.File |
getJavadocDirectory()
|
protected java.lang.String |
getOutputDirectory()
|
protected java.io.File |
getOverview()
|
protected java.util.List |
getProjectArtifacts(org.apache.maven.project.MavenProject p)
|
protected java.util.List |
getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
|
protected java.util.List |
getProjectSourceRoots(org.apache.maven.project.MavenProject p)
|
protected java.util.List |
getSourcePaths()
Method to get the source paths. |
protected java.lang.String |
getWindowtitle()
|
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 |
Methods inherited from interface org.apache.maven.plugin.Mojo |
---|
execute |
Field Detail |
---|
protected org.apache.maven.project.MavenProject project
protected boolean aggregate
protected java.io.File outputDirectory
Constructor Detail |
---|
public AbstractJavadocMojo()
Method Detail |
---|
protected java.lang.String getOutputDirectory()
protected java.util.List getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
p
- a maven project
protected java.util.List getProjectSourceRoots(org.apache.maven.project.MavenProject p)
p
- a maven project
protected java.util.List getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
p
- a maven project
protected java.util.List getProjectArtifacts(org.apache.maven.project.MavenProject p)
p
- a maven project
protected java.io.File getJavadocDirectory()
protected java.lang.String getDoctitle()
protected java.io.File getOverview()
javadocdirectory
protected java.lang.String getWindowtitle()
protected void executeReport(java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
locale
- the wanted locale (actually unused).
org.apache.maven.reporting.MavenReportException
- if anyprotected java.util.List getFiles(java.util.List sourcePaths)
sourcePaths
- a List that contains the paths to the source files
protected java.util.List getSourcePaths()
protected boolean canGenerateReport(java.util.List files)
files
- the project files
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |