配置样式表

如果在<stylesheetfile/>参数中未指定自定义样式表,则<stylesheet/>参数将指示将使用哪个样式表——maven javadoc 插件中包含的样式表或 javadoc 工具使用的默认样式表。maven值表示 maven javadoc 插件样式表,而java值表示默认的 javadoc 工具样式表。如果未指定,则默认为java值。

<project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          <stylesheet>maven</stylesheet>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>

配置样式表文件

如果指定了自定义<stylesheetfile/>参数,您将能够使用它:

  • 如果<stylesheetfile/>是给定文件,则可以使用绝对路径或相对路径,例如:
    <project>
      ...
      <reporting> (or <build>)
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.3.2</version>
            <configuration>
              <stylesheetfile>${basedir}/path/to/your/stylesheetfile.css</stylesheetfile>
              ...
            </configuration>
          </plugin>
        </plugins>
        ...
      </reporting> (or </build>)
      ...
    </project>
    
  • 从 2.6 开始,<stylesheetfile/>可以是项目目录中的资源,即src/main/javasrc/main/resourcessrc/main/javadoc,例如:
    <project>
      ...
      <reporting> (or <build>)
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.3.2</version>
            <configuration>
              <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
              ...
            </configuration>
          </plugin>
        </plugins>
        ...
      </reporting> (or </build>)
      ...
    </project>
    
  • 从 2.6 开始,<stylesheetfile/>可以是 Javadoc 插件依赖项中的资源,例如:
    <project>
      ...
      <build>
        <plugins>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.3.2</version>
            <configuration>
              <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
            </configuration>
            <dependencies>
              <dependency>
                <groupId>groupId</groupId>
                <artifactId>artifactId</artifactId>
                <version>version</version>
              </dependency>
            </dependencies>
          </plugin>
        </plugins>
        ...
      </build>
      ...
    </project>