ScalaDocMojoDescriptorExtractor

MojoDescriptorExtractor implementation that delegates to the OOTB JavaAnnotationsExtractor (<extractor>java-annotations</extractor>) to extract all the details it can from the standard java annotations, which are retained in the .class files after compilation, and then decorates those extracted descriptors with the details that can only be found in the javadoc/scaladoc comments in the source files, namely: @deprecated, @since, and most importantly, description

Annotations: @Component()
Since: 0.6.0

Linear Supertypes

MojoDescriptorExtractor, AnyRef, Any

Instance Constructors

new ScalaDocMojoDescriptorExtractor()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def execute(request: PluginToolsRequest): List[MojoDescriptor]

First calls the java-annotations extractor to generate the initial list of MojoDescriptors, then compiles the scala sources using a ScalaDoc-enabled compiler to generate a model, which is then used by a decorating function to add description, @since, and @deprecated text to each MojoDescriptor
First calls the java-annotations extractor to generate the initial list of MojoDescriptors, then compiles the scala sources using a ScalaDoc-enabled compiler to generate a model, which is then used by a decorating function to add description, @since, and @deprecated text to each MojoDescriptor
request
the PluginToolsRequest
returns
a java list of extracted MojoDescriptors

Definition Classes
ScalaDocMojoDescriptorExtractor → MojoDescriptorExtractor
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getSourceRoots(p: Option[MavenProject]): List[String]

List the source roots specified by the MavenProject, if available
List the source roots specified by the MavenProject, if available
p
the optional MavenProject
returns
a list of source roots
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var javaAnnotationsExtractor: MojoDescriptorExtractor

the java-annotations extractor
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def useCompiler(request: PluginToolsRequest, sourceFiles: List[String], descriptors: List[MojoDescriptor]): List[MojoDescriptor]

Create a new ScalaDoc compiler and decorate the list of descriptors
Create a new ScalaDoc compiler and decorate the list of descriptors
request
the PluginToolsRequest
sourceFiles
the list of scala sources to compile
descriptors
the list of descriptors extracted by the java-annotations MojoDescriptor
returns
a list of decorated MojoDescriptors
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def execute(project: MavenProject, pluginDescriptor: PluginDescriptor): List[MojoDescriptor]

Deprecated
Use execute(PluginToolsRequest) instead. Provided for backward compatibility with maven-plugin-plugin < 2.5.
See also
MojoDescriptorExtractor#execute(MavenProject, PluginDescriptor)

Related Docs: object ScalaDocMojoDescriptorExtractor | package scalamojo

class ScalaDocMojoDescriptorExtractor extends MojoDescriptorExtractor

Instance Constructors

new ScalaDocMojoDescriptorExtractor()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execute(request: PluginToolsRequest): List[MojoDescriptor]

def finalize(): Unit

final def getClass(): Class[_]

def getSourceRoots(p: Option[MavenProject]): List[String]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

var javaAnnotationsExtractor: MojoDescriptorExtractor

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

def useCompiler(request: PluginToolsRequest, sourceFiles: List[String], descriptors: List[MojoDescriptor]): List[MojoDescriptor]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def execute(project: MavenProject, pluginDescriptor: PluginDescriptor): List[MojoDescriptor]

Inherited from MojoDescriptorExtractor

Inherited from AnyRef

Inherited from Any

Ungrouped