Configuring Stylesheets

If no custom stylesheet is specified in the <stylesheetfile/> parameter, the <stylesheet/> parameter will indicate which stylesheet will be used -- the stylesheet included in the maven javadoc plugin or the default stylesheet used by the javadoc tool. maven value indicates the maven javadoc plugin stylesheet, while java value indicates the default javadoc tool stylesheet. The default is java value if not specified.

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

Configuring Stylesheets File

If a custom <stylesheetfile/> parameter is specified, you will be able to use it:

  • if <stylesheetfile/> is a given file, you could use an absolute or a relative path, for instance:
    <project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.7</version>
        <configuration>
          <stylesheetfile>${basedir}/path/to/your/stylesheetfile.css</stylesheetfile>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>
  • since 2.6, <stylesheetfile/> could be a resource in your project directory, i.e. src/main/java, src/main/resources or src/main/javadoc, for instance:
    <project>
  ...
  <reporting> (or <build>)
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.7</version>
        <configuration>
          <stylesheetfile>path/to/your/stylesheet.css</stylesheetfile>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting> (or </build>)
  ...
</project>
  • since 2.6, <stylesheetfile/> could be a resource in the Javadoc plugin dependencies, for instance:
    <project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.7</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>