Class

net.adamcin.scalamojo

ScalaDocBasedPluginReport

Related Doc: package scalamojo

Permalink

class ScalaDocBasedPluginReport extends PluginReport

Maven report goal that overrides the maven-plugin-plugin report goal to limit the active extractors to java-annotations-and-scaldoc. This is generally necessary for reliable scala plugin report generation using this plugin's extractor, since the java-annotations extractor must always be on the classpath alongside it, and the maven-plugin-plugin report does not expose a similar configuration to that of the xdoc goal.

Annotations
@Mojo() @Execute()
Since

0.6.0

Linear Supertypes
PluginReport, AbstractMavenReport, MavenMultiPageReport, MavenReport, AbstractMojo, ContextEnabled, Mojo, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaDocBasedPluginReport
  2. PluginReport
  3. AbstractMavenReport
  4. MavenMultiPageReport
  5. MavenReport
  6. AbstractMojo
  7. ContextEnabled
  8. Mojo
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScalaDocBasedPluginReport()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def canGenerateReport(): Boolean

    Permalink
    Definition Classes
    PluginReport → AbstractMavenReport → MavenReport

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. def closeReport(): Unit

    Permalink
    Attributes
    protected[org.apache.maven.reporting]
    Definition Classes
    AbstractMavenReport

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def execute(): Unit

    Permalink
    Definition Classes
    AbstractMavenReport → Mojo
    Annotations
    @throws( ... )

  11. def executeReport(locale: Locale): Unit

    Permalink
    Definition Classes
    ScalaDocBasedPluginReport → PluginReport → AbstractMavenReport

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. def generate(arg0: Sink, arg1: SinkFactory, arg2: Locale): Unit

    Permalink
    Definition Classes
    AbstractMavenReport → MavenMultiPageReport
    Annotations
    @throws( ... )

  14. def getCategoryName(): String

    Permalink
    Definition Classes
    AbstractMavenReport → MavenReport

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def getDescription(arg0: Locale): String

    Permalink
    Definition Classes
    PluginReport → MavenReport

  17. def getInputEncoding(): String

    Permalink
    Attributes
    protected[org.apache.maven.reporting]
    Definition Classes
    AbstractMavenReport

  18. def getLog(): Log

    Permalink
    Definition Classes
    AbstractMojo → Mojo

  19. def getName(arg0: Locale): String

    Permalink
    Definition Classes
    PluginReport → MavenReport

  20. def getOutputDirectory(): String

    Permalink
    Attributes
    protected[org.apache.maven.plugin.plugin]
    Definition Classes
    PluginReport → AbstractMavenReport

  21. def getOutputEncoding(): String

    Permalink
    Attributes
    protected[org.apache.maven.reporting]
    Definition Classes
    AbstractMavenReport

  22. def getOutputName(): String

    Permalink
    Definition Classes
    PluginReport → MavenReport

  23. def getPluginContext(): Map

    Permalink
    Definition Classes
    AbstractMojo → ContextEnabled

  24. def getProject(): MavenProject

    Permalink
    Attributes
    protected[org.apache.maven.plugin.plugin]
    Definition Classes
    PluginReport → AbstractMavenReport

  25. def getReportOutputDirectory(): File

    Permalink
    Definition Classes
    AbstractMavenReport → MavenReport

  26. def getSink(): Sink

    Permalink
    Definition Classes
    AbstractMavenReport

  27. def getSinkFactory(): SinkFactory

    Permalink
    Definition Classes
    AbstractMavenReport

  28. def getSiteRenderer(): Renderer

    Permalink
    Attributes
    protected[org.apache.maven.plugin.plugin]
    Definition Classes
    PluginReport → AbstractMavenReport

  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  30. def isExternalReport(): Boolean

    Permalink
    Definition Classes
    AbstractMavenReport → MavenReport

  31. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  35. def setLog(arg0: Log): Unit

    Permalink
    Definition Classes
    AbstractMojo → Mojo

  36. def setPluginContext(arg0: Map): Unit

    Permalink
    Definition Classes
    AbstractMojo → ContextEnabled

  37. def setReportOutputDirectory(arg0: File): Unit

    Permalink
    Definition Classes
    AbstractMavenReport → MavenReport

  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def generate(arg0: Sink, arg1: Locale): Unit

    Permalink
    Definition Classes
    AbstractMavenReport
    Annotations
    @deprecated @throws( ... )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def generate(arg0: Sink, arg1: Locale): Unit

    Permalink
    Definition Classes
    AbstractMavenReport → MavenReport
    Annotations
    @deprecated @throws( ... )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from PluginReport

Inherited from AbstractMavenReport

Inherited from MavenMultiPageReport

Inherited from MavenReport

Inherited from AbstractMojo

Inherited from ContextEnabled

Inherited from Mojo

Inherited from AnyRef

Inherited from Any

Ungrouped