scalamojo

Type Members

1. class MojoReporter extends AbstractReporter

   

   Implementation of Reporter for use by DocFactory compiler

   Implementation of Reporter for use by DocFactory compiler

   Since

   0.6.0

2. 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.

   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

3. class ScalaDocExtractorCompiler extends AnyRef

   

   Wraps a ScalaDoc-compiled model in a MojoDescriptor decorator function

   Wraps a ScalaDoc-compiled model in a MojoDescriptor decorator function

   Since

   0.6.0

4. class ScalaDocMojoDescriptorExtractor extends MojoDescriptorExtractor

   

   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

   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