Configuring Help File

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

  • if <helpfile/> 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.10.1</version>
            <configuration>
              <helpfile>${basedir}/path/to/your/helpfile</helpfile>
              ...
            </configuration>
          </plugin>
        </plugins>
        ...
      </reporting> (or </build>)
      ...
    </project>
    
  • since 2.6, <helpfile/> 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.10.1</version>
            <configuration>
              <helpfile>path/to/your/resource/help-doc.html</helpfile>
              ...
            </configuration>
          </plugin>
        </plugins>
        ...
      </reporting> (or </build>)
      ...
    </project>
    
  • since 2.6, <helpfile/> 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.10.1</version>
            <configuration>
              <helpfile>path/to/your/resource/help-doc.html</helpfile>
            </configuration>
            <dependencies>
              <dependency>
                <groupId>groupId</groupId>
                <artifactId>artifactId</artifactId>
                <version>version</version>
              </dependency>
            </dependencies>
          </plugin>
        </plugins>
        ...
      </build>
      ...
    </project>