|
||||||||||
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 boolean |
aggregateDirectOnly
If you want to aggregate only direct sub modules. |
protected String[] |
args
compiler additionnals arguments |
protected String |
bottom
Specifies the text to be placed at the bottom of each output file. |
protected String |
charset
Charset for cross-platform viewing of generated documentation. |
protected boolean |
checkMultipleScalaVersions
Check if every dependencies use the same version of scala-library. |
protected BasicArtifact[] |
compilerPlugins
Compiler plugin dependencies to use when compiling. |
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 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 boolean |
failOnMultipleScalaVersions
Determines if a detection of multiple scala versions in the dependencies will cause the build to fail. |
protected String |
footer
Include footer text for each page. |
protected boolean |
forceAggregate
To allow running aggregation only from command line use "-Dforce-aggregate=true" (avoid using in pom.xml). |
protected boolean |
forceUseArgFile
Force the use of an external ArgFile to run any forked process. |
protected boolean |
fork
Forks the execution of scalac into a separate process. |
protected String |
header
Include header text for each page |
protected 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 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 String |
SCALA_GROUPID
|
static String |
SCALA_LIBRARY_ARTIFACTID
|
protected String |
scalaClassName
className (FQN) of the scala tool to provide as |
protected String |
scaladocClassName
className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used |
protected String |
scalaVersion
Scala 's version to use |
protected File |
sourceDir
|
protected File |
stylesheetfile
File to change style of the generated documentation |
protected String |
top
Include top text for each page |
protected 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 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,
Set<String> classpath)
|
protected void |
addToClasspath(String groupId,
String artifactId,
String version,
Set<String> classpath)
|
protected void |
aggregate(org.apache.maven.project.MavenProject parent)
|
boolean |
canGenerateReport()
|
protected void |
checkScalaVersion()
|
void |
doExecute()
|
void |
execute()
|
void |
generate(org.apache.maven.doxia.sink.Sink sink,
Locale locale)
|
String |
getCategoryName()
|
protected List<org.apache.maven.model.Dependency> |
getDependencies()
|
String |
getDescription(Locale locale)
|
protected JavaMainCaller |
getEmptyScalaCommand(String mainClass)
|
String |
getName(Locale locale)
|
String |
getOutputName()
|
File |
getReportOutputDirectory()
|
protected JavaMainCaller |
getScalaCommand()
|
boolean |
isExternalReport()
|
protected boolean |
isJavaSupportedByCompiler()
|
protected JavaMainCaller |
newScalaDocCmd()
|
protected Set<org.apache.maven.artifact.Artifact> |
resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact)
This method resolves all transitive dependencies of an artifact. |
protected Set<org.apache.maven.artifact.Artifact> |
resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject)
This method resolves the dependency artifacts from the project. |
void |
setReportOutputDirectory(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 String windowtitle
protected String bottom
protected String charset
protected String doctitle
protected String footer
protected String header
protected boolean linksource
protected boolean nocomment
protected File stylesheetfile
protected String top
protected File sourceDir
protected String scaladocClassName
protected String vscaladocVersion
protected boolean forceAggregate
protected boolean aggregateDirectOnly
public static final String SCALA_GROUPID
public static final 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 List<?> remoteRepos
protected BasicArtifact[] dependencies
protected BasicArtifact[] compilerPlugins
protected String[] jvmArgs
protected String[] args
protected String scalaClassName
protected String scalaVersion
protected boolean displayCmd
protected boolean fork
protected boolean forceUseArgFile
protected boolean checkMultipleScalaVersions
protected boolean failOnMultipleScalaVersions
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 String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public String getDescription(Locale locale)
getDescription
in interface org.apache.maven.reporting.MavenReport
public String getName(Locale locale)
getName
in interface org.apache.maven.reporting.MavenReport
public String getOutputName()
getOutputName
in interface org.apache.maven.reporting.MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void doExecute() throws Exception
Exception
protected JavaMainCaller getScalaCommand() throws Exception
Exception
public void generate(org.apache.maven.doxia.sink.Sink sink, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenReport
org.apache.maven.reporting.MavenReportException
protected JavaMainCaller newScalaDocCmd() throws Exception
Exception
protected void aggregate(org.apache.maven.project.MavenProject parent) throws Exception
Exception
protected Set<org.apache.maven.artifact.Artifact> resolveDependencyArtifacts(org.apache.maven.project.MavenProject theProject) throws Exception
theProject
- The POM.
org.apache.maven.artifact.resolver.ArtifactResolutionException
org.apache.maven.artifact.resolver.ArtifactNotFoundException
org.apache.maven.project.artifact.InvalidDependencyVersionException
Exception
protected Set<org.apache.maven.artifact.Artifact> resolveArtifactDependencies(org.apache.maven.artifact.Artifact artifact) throws 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
Exception
protected void addToClasspath(String groupId, String artifactId, String version, Set<String> classpath) throws Exception
Exception
protected void addToClasspath(org.apache.maven.artifact.Artifact artifact, Set<String> classpath) throws Exception
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 List<org.apache.maven.model.Dependency> getDependencies()
protected void checkScalaVersion() throws Exception
Exception
protected JavaMainCaller getEmptyScalaCommand(String mainClass) throws Exception
Exception
protected boolean isJavaSupportedByCompiler()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |