Генерировать стандартную документацию плагина maven

#maven #maven-plugin #maven-site-plugin

#maven #maven-плагин #maven-site-plugin

Вопрос:

Плагины Maven следуют стандартному шаблону для документации, например,

https://maven.apache.org/maven-release/maven-release-plugin/index.html

с разделом «цели», «использование» и т. Д. И Каждой целью с выделенной страницей.

Как я могу создать такую документацию для моего собственного плагина Maven?

Ответ №1:

Глядя на один из моих собственных проектов, я думаю, что это просто:

 <reporting>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-plugin-plugin</artifactId>
            <version>${maven.plugin.plugin.version}</version>
            <reportSets>
                <reportSet>
                    <reports>
                        <report>report</report>  <!-- generates standard Maven plugin docs -->
                    </reports>
                </reportSet>
            </reportSets>
        </plugin>
    </plugins>

</reporting>
  

Параметры конфигурации находятся в документации плагина.