Das Plugin hat die Aufgabe beim Erzeugen von Dokumentation zu unterstützten. Dabei wird an die geforderte Verzeichnisstruktur (siehe Dokumentation von mathcoach-docs) angeknüpft. Das Plugin wird nur im Artefakt mathcoach verwendet, nachdem alle Teildokumentationen in ein Verzeichnis kopiert wurden. Dabei werden Folgende Tätigkeiten vorgenommen:

Erstellen der Groovy-API Dokumentation

Die Groovy-API für MathCoach-Aufgaben wird mit Annotationen beschrieben. Ein Annotation-Prozessor erzeugt aus diesen Java-Klassen (Datencontainer), die mit der SPI (Service Provider Interfaces) Schnittstelle aufgegriffen werden können. Das Plugin hat die Aufgabe auf Basis dieser Datencontainer eine .adoc-Datei zu erzeugen. Folgende Konfiguration ist notwendig:

<execution>
        <id>generate groovy documentation</id>
        <!--
        <configuration>
                <outputDirectory>${project.build.directory}/${project.artifactId}-${project.version}/mc-docs/author/generated/groovy/</outputDirectory>
        </configuration>
        -->
        <phase>compile</phase>
        <goals>
                <goal>generate-docs-groovy</goal>
        </goals>
</execution>
Erstellen von Index-Dateien

Jedes Artefakt kann Entwickler-Dokumentation mit dem Einstiegspunkt mc-docs/developer/modules/<name>/main.adoc anbieten. Das Goal create-module-index-file des Plugins erstellt eine Index-Datei aller Modul-Dokumentationen unter mc-docs/developer/modules/index.adoc. Folgende Konfiguration des Plugins ist dazu notwendig:

<execution>
        <id>create index for modules</id>
        <configuration>
                <workingDirectory>${project.build.directory}/${project.artifactId}-${project.version}/mc-docs/developer/modules/</workingDirectory>
        </configuration>
        <phase>compile</phase>
        <goals>
                <goal>create-module-index-file</goal>
        </goals>
</execution>