Tut Maven Plugin

Maven plugin for generating compiled Scala documentation

License	BSD 3-clause
Categories	Maven Build Tools
GroupId	org.spurint.maven.plugins
ArtifactId	tut-maven-plugin
Last Version	0.6.13
Release Date	Dec 11, 2019
Type	maven-plugin
Description	Tut Maven Plugin Maven plugin for generating compiled Scala documentation
Project URL	https://github.com/kelnos/tut-maven-plugin
Source Code Management	https://github.com/kelnos/tut-maven-plugin

Download tut-maven-plugin

Filename	Size
tut-maven-plugin-0.6.13.pom
tut-maven-plugin-0.6.13.jar	27 KB
tut-maven-plugin-0.6.13-sources.jar	9 KB
tut-maven-plugin-0.6.13-javadoc.jar	23 KB

How to add to project

Apache Maven

<plugin>
    <groupId>org.spurint.maven.plugins</groupId>
    <artifactId>tut-maven-plugin</artifactId>
    <version>0.6.13</version>
</plugin>

Dependencies

compile (5)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.9
org.apache.maven : maven-plugin-api	jar	3.6.0
org.apache.maven.shared : maven-common-artifact-filters	jar	3.1.0
org.apache.maven.shared : maven-artifact-transfer	jar	0.11.0
org.codehaus.plexus : plexus-utils	jar	3.2.0

provided (2)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.6.0
org.apache.maven : maven-project	jar	3.0-alpha-2

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.8.2

Project Modules

There are no modules declared in this project.

tut-maven-plugin

This is a Maven plugin that allows you to generate Scala documentation snippets that contain code that is compiled to ensure the code is valid. This is just a Maven plugin shell; the original project that does the heavy lifting can be found here.

Releases here will match the version of the corresponding Tut release. If extra releases of this plugin are required for a given Tut version, a fourth version component will be added to the plugin's version number.

Usage

<build>
  <plugins>
    <plugin>
      <groupId>org.spurint.maven.plugins</groupId>
      <artifactId>tut-maven-plugin</artifactId>
      <version>${tut-maven-plugin.version}</version>
      <executions>
        <execution>
          <id>generate-documentation</id>
          <goals>
            <goal>generate-documentation</goal>
          </goals>
          <configuration>
            <sourceDirectory>${project.basedir}/docs-src</sourceDirectory>
            <targetDirectory>${project.basedir}/docs</targetDirectory>
            <nameFilter>.*\\.(md|markdown|txt|htm|html)$</nameFilter>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Configuration

Name	Default	Description
sourceDirectory	${project.basedir}/docs-src	The source root containing files to parse
targetDirectory	${project.basedir}/docs	The location to place generated documenation
nameFiter	.*\\.(md|markdown|txt|htm|html)$	A regular expression describing file names to be processed
scalacOptions	(taken from project)	A list of <scalacOption> to pass to the Scala compiler
pluginJars	(taken from project)	A list of <pluginJar>, paths to JAR files of compiler plugins

Versions

Version
0.6.13 Dec 11, 2019
0.6.9 Aug 24, 2019