MapStruct Doc - Maven & Gradle Plugin

⚠️ WORK IN PROGRESS !!!

• What is MapStruct Doc?
• Requirements
• Using MapStruct Doc
  • Maven
• Contributors
• Licensing

---

What is MapStruct Doc?

MapStruct Doc is a Java annotation processor for the generation of documentation for mapping interface (CSV, Markdown or AsciiDoc).

At compile time MapStruct will generate a file for each interface.

Features

Feature	State	Note
generate-csv	🚧
generate-text	❌
generate-markdown	❌
generate-html	❌
generate-asciidoc	❌
maven	✔️
maven-site	❌
gradle	❌
scan-javadoc	❌

Requirements

MapStruct Doc requires Java 1.8 or later.

Using MapStruct Doc

Maven

For Maven-based projects, add the following to your POM file in order to use MapStruct Doc:

<project>
  ...
  <properties>
    <mapstruct-doc.version>1.5.5-SNAPSHOT</mapstruct-doc.version>
  </properties>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>com.damienfremont.mapstruct</groupId>
        <artifactId>mapstruct-doc-maven-plugin</artifactId>
        <version>${mapstruct-doc.version}</version>
        <configuration>
          <include>com.damienfremont.mapstruct.example.getstarted.CarMapper</include>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>generate</goal>
            </goals>
            <phase>install</phase>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

And execute any of the following commands:

mvn install -DskipTests

mvn com.damienfremont.mapstruct:mapstruct-doc-maven-plugin:1.5.5-SNAPSHOT:generate

Contributors

Want to contribute? CONTRIBUTING.md

Licensing

Copyright (c) 2023 Damien FREMONT.

Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0