如何在Maven插件网站的文档中包括目标和参数

Question

看来您可以生成标准文档网站（例如 这个）来自Maven插件项目。我尝试执行 mvn site 在插件项目中，但不会生成预期的文档（一个显示Mojo目标，参数等的页面）。是否还必须调用其他目标来生成这些网页？我正在使用Mavenv。2.1.0。

Answer 1

为了获取网站文档中包含的插件文档（目标，参数等），您需要将以下内容添加到pom.xml

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-plugin</artifactId>
        <version>2.5.1</version>
      </plugin>
    </plugins>
  </reporting>    
  ...
</project>

这添加了一个“项目报告”链接到网站菜单，该链接显示了Maven插件相当于Javadoc。

Answer 2

盒子外面， mvn site 至少应该生成一个索引页（并利用 name 和 description从项目的POM）和一组基本的报告（关于，问题跟踪，项目团队，依赖项，项目插件，连续集成，源存储库，项目许可证，邮件列表，插件管理，项目摘要）。

如果要自定义一组报告，则可以配置 Maven项目信息报告插件 （在里面 reporting 部分）仅包括您想要的报告：

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.2</version>
        <reportSets>
          <reportSet>
            <reports>
              <report>dependencies</report>
              <report>project-team</report>
              <report>mailing-list</report>
              <report>cim</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

如果您想自定义网站，则需要提供一个 站点描述符 (src/site/site.xml 默认情况下）。在这种情况下，您必须包括一个 <menu ref="reports"/> 上述报告的条目。

如果你想 添加内容, ，您必须使用支持格式之一（例如APT，FML，XDOC）提供它。大多数时候， 易于 如今已使用。

检查文档 Maven站点插件 更多细节。

Answer 3

它没有生成什么？这很奇怪，它至少应该建立一个非常基本的网站，其中包含一般信息和依赖性文档。 maven site是正确的电话。

对于其他文档（Javadoc，测试报告等），您需要在构建文件中添加更多元素。请查看SureFire插件文档以获取一些示例。

Answer 4

不，但是您的项目应包含特定的结构，如图所示 这里.