README.md

DocuMaid

DocuMaid keeps your documentation in sync with your codebase.

Usage

To generate the documentation:

mvn de.quantummaid:documaid:0.9.35:generate
mvn de.quantummaid:documaid:0.9.35:generate -DskipPaths=docs/Usage.md

To validate whether the current documentation is correct and does not require any changes:

mvn de.quantummaid:documaid:0.9.35:validate

Maven Configuration

<plugin>
    <groupId>de.quantummaid</groupId>
    <artifactId>documaid</artifactId>
    <version>0.9.45</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <phase>verify</phase>
        </execution>
    </executions>
</plugin>

The full documentation can be found here.