Class JavadocMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.eclipse.tycho.extras.docbundle.JavadocMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="javadoc", defaultPhase=PROCESS_CLASSES, requiresDependencyResolution=COMPILE_PLUS_RUNTIME, threadSafe=false) public class JavadocMojo extends org.apache.maven.plugin.AbstractMojo
Create the javadoc based API reference for this bundle
This mojo creates the javadoc documentation by calling the javadoc application from the command line. In addition it creates a ready to include toc-xml file for the Eclipse Help system.
The sources for creating the javadoc are generated automatically based on the dependency that this project has. As dependency you can specify any other maven project, for example the feature project that references you other bundles. Included features will be added to the list.- Since:
- 0.20.0
-
-
Field Summary
Fields Modifier and Type Field Description protected List<org.apache.maven.project.MavenProject>
reactorProjects
-
Constructor Summary
Constructors Constructor Description JavadocMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute()
void
setJavadocOptions(JavadocOptions javadocOptions)
void
setScopes(Set<String> scopes)
void
setSourceTypes(Set<String> sourceTypes)
void
setTocOptions(TocOptions tocOptions)
-
-
-
Field Detail
-
reactorProjects
@Parameter(property="reactorProjects", required=true, readonly=true) protected List<org.apache.maven.project.MavenProject> reactorProjects
-
-
Method Detail
-
setTocOptions
public void setTocOptions(TocOptions tocOptions)
-
setJavadocOptions
public void setJavadocOptions(JavadocOptions javadocOptions)
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
-