Docufier Maven Plugin

Maven plugin to run docufier

License	MIT license
GroupId	org.buildobjects
ArtifactId	docufier-plugin
Last Version	0.0.2
Release Date	Oct 10, 2016
Type	maven-plugin
Description	Docufier Maven Plugin Maven plugin to run docufier
Project URL	https://github.com/programmiersportgruppe/docufier
Source Code Management	https://github.com/programmiersportgruppe/docufier-plugin

Download docufier-plugin

Filename	Size
docufier-plugin-0.0.2.pom
docufier-plugin-0.0.2.jar	5 KB
docufier-plugin-0.0.2-sources.jar	4 KB
docufier-plugin-0.0.2-javadoc.jar	23 KB

How to add to project

Apache Maven

<plugin>
    <groupId>org.buildobjects</groupId>
    <artifactId>docufier-plugin</artifactId>
    <version>0.0.2</version>
</plugin>

Dependencies

compile (4)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.2.2
org.codehaus.plexus : plexus-utils	jar	3.0.17
commons-io : commons-io	jar	2.4
org.buildobjects : docufier	jar	0.0.1

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.3

test (3)

Group / Artifact	Type	Version
org.apache.maven.plugin-testing : maven-plugin-testing-harness	jar	3.1.0
org.apache.maven : maven-core	jar	3.2.2
org.apache.maven : maven-compat	jar	3.2.2

Project Modules

There are no modules declared in this project.

Docufier Maven Plugin

Continuous integration:

This plugin runs docufier as part of your maven build to generate documentation from JUnit tests.

To get started you need to add the plugin to your maven build:

<build>
    <plugins>

        <plugin>
            <groupId>org.buildobjects</groupId>
            <artifactId>docufier-plugin</artifactId>
            <version>0.0.2</version>
            <executions>
                <execution>
                    <phase>generate-resources</phase>
                    <goals>
                        <goal>docufy</goal>
                    </goals>
                </execution>
            </executions>            
        </plugin>
    </plugins>
</build>

Per default the plugin tries to read test cases from src/test/java and writes to target/doc.

These directories can be configured by adding a configuration element to the plugin config:

<configuration>
    <outputDirectory>src/test/java</outputDirectory>
    <outputDirectory>target/md</outputDirectory>
</configuration>

programmiersportgruppe

Versions

Version
0.0.2 Oct 10, 2016
0.0.1 Oct 10, 2016