|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.scala_tools.maven.ScalaDocMojo
public class ScalaDocMojo
Produces Scala API documentation.
Field Summary | |
---|---|
protected java.lang.String[] |
args
compiler additionnals arguments |
protected java.lang.String |
bottom
Specifies the text to be placed at the bottom of each output file. |
protected java.lang.String |
charset
Charset for cross-platform viewing of generated documentation. |
protected BasicArtifact[] |
dependencies
Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : <dependencies> <dependency> <groupId>org.scala-tools</groupId> <artifactId>scala-compiler-addon</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies> |
protected boolean |
displayCmd
Display the command line called ? |
protected java.lang.String |
doctitle
Include title for the overview page. |
protected org.apache.maven.artifact.factory.ArtifactFactory |
factory
Used to look up Artifacts in the remote repository. |
protected java.lang.String |
footer
Include footer text for each page. |
protected java.lang.String |
header
Include header text for each page |
protected java.lang.String[] |
jvmArgs
Jvm Arguments. |
protected boolean |
linksource
Generate source in HTML |
protected org.apache.maven.artifact.repository.ArtifactRepository |
localRepo
Location of the local repository. |
protected org.apache.maven.project.MavenProjectBuilder |
mavenProjectBuilder
Artifact factory, needed to download source jars. |
protected boolean |
nocomment
Suppress description and tags, generate only declarations |
protected org.apache.maven.project.MavenProject |
project
|
protected java.util.List<?> |
remoteRepos
List of Remote Repositories used by the resolver |
protected org.apache.maven.artifact.resolver.ArtifactResolver |
resolver
Used to look up Artifacts in the remote repository. |
static java.lang.String |
SCALA_GROUPID
|
static java.lang.String |
SCALA_LIBRARY_ARTIFACTID
|
protected java.lang.String |
scalaClassName
className (FQN) of the scala tool to provide as |
protected java.lang.String |
scaladocClassName
className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used |
protected java.lang.String |
scalaVersion
Scala 's version to use |
protected java.io.File |
sourceDir
|
protected java.io.File |
stylesheetfile
File to change style of the generated documentation |
protected java.lang.String |
top
Include top text for each page |
protected java.lang.String |
vscaladocVersion
If you want to use vscaladoc to generate api instead of regular scaladoc, set the version of vscaladoc you want to use. |
protected java.lang.String |
windowtitle
Specify window title of generated HTML documentation. |
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 | |
---|---|
ScalaDocMojo()
|
Method Summary | |
---|---|
protected void |
addToClasspath(org.apache.maven.artifact.Artifact artifact,
java.util.Set<java.lang.String> classpath)
|
protected void |
addToClasspath(java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version,
java.util.Set<java.lang.String> classpath)
|
boolean |
canGenerateReport()
|
protected void |
checkScalaVersion()
|
void |
doExecute()
|
void |
execute()
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
java.util.Locale locale)
|
java.lang.String |
getCategoryName()
|
protected java.util.List<org.apache.maven.model.Dependency> |
getDependencies()
|
java.lang.String |
getDescription(java.util.Locale locale)
|
protected JavaCommand |
getEmptyScalaCommand(java.lang.String mainClass)
|
java.lang.String |
getName(java.util.Locale locale)
|
java.lang.String |
getOutputName()
|
java.io.File |
getReportOutputDirectory()
|
protected JavaCommand |
getScalaCommand()
|
boolean |
isExternalReport()
|
protected java.util.Set<org.apache.maven.artifact.Artifact> |
resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact)
This method resolves all transitive dependencies of an artifact. |
protected java.util.Set<org.apache.maven.artifact.Artifact> |
resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject)
This method resolves the dependency artifacts from the project. |
void |
setReportOutputDirectory(java.io.File reportOutputDirectory)
|
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 |
---|
protected java.lang.String windowtitle
protected java.lang.String bottom
protected java.lang.String charset
protected java.lang.String doctitle
protected java.lang.String footer
protected java.lang.String header
protected boolean linksource
protected boolean nocomment
protected java.io.File stylesheetfile
protected java.lang.String top
protected java.io.File sourceDir
protected java.lang.String scaladocClassName
protected java.lang.String vscaladocVersion
public static final java.lang.String SCALA_GROUPID
public static final java.lang.String SCALA_LIBRARY_ARTIFACTID
protected org.apache.maven.project.MavenProject project
protected org.apache.maven.artifact.factory.ArtifactFactory factory
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver
protected org.apache.maven.artifact.repository.ArtifactRepository localRepo
protected java.util.List<?> remoteRepos
protected BasicArtifact[] dependencies
protected java.lang.String[] jvmArgs
protected java.lang.String[] args
protected java.lang.String scalaClassName
protected java.lang.String scalaVersion
protected boolean displayCmd
protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder
Constructor Detail |
---|
public ScalaDocMojo()
Method Detail |
---|
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getDescription(java.util.Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getName(java.util.Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
public java.lang.String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
public java.io.File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void doExecute() throws java.lang.Exception
java.lang.Exception
protected JavaCommand getScalaCommand() throws java.lang.Exception
java.lang.Exception
public void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenReport
org.apache.maven.reporting.MavenReportException
protected java.util.Set<org.apache.maven.artifact.Artifact> resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject) throws java.lang.Exception
theProject
- The POM.
org.apache.maven.artifact.resolver.ArtifactResolutionException
org.apache.maven.artifact.resolver.ArtifactNotFoundException
org.apache.maven.project.artifact.InvalidDependencyVersionException
java.lang.Exception
protected java.util.Set<org.apache.maven.artifact.Artifact> resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact) throws java.lang.Exception
artifact
- the artifact used to retrieve dependencies
org.apache.maven.artifact.resolver.ArtifactResolutionException
org.apache.maven.artifact.resolver.ArtifactNotFoundException
org.apache.maven.project.ProjectBuildingException
org.apache.maven.project.artifact.InvalidDependencyVersionException
java.lang.Exception
protected void addToClasspath(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.util.Set<java.lang.String> classpath) throws java.lang.Exception
java.lang.Exception
protected void addToClasspath(org.apache.maven.artifact.Artifact artifact, java.util.Set<java.lang.String> classpath) throws java.lang.Exception
java.lang.Exception
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
protected java.util.List<org.apache.maven.model.Dependency> getDependencies()
protected void checkScalaVersion() throws java.lang.Exception
java.lang.Exception
protected JavaCommand getEmptyScalaCommand(java.lang.String mainClass) throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |