testdoc-maven-report-plugin

Using Indices

An index is used to get an additional view in the test stories. The index implementation has to implement the ExportIndex interface and provide a no args constructor.

Adding one Index

The UutPackageIndex creates an index over the packages of the UUTs being documented.

<plugin>
  <groupId>de.smartics.testdoc</groupId>
  <artifactId>testdoc-maven-report-plugin</artifactId>
  <version>${project.version}</version>
  <configuration>
    <indices>
      <index>de.smartics.testdoc.report.index.UutPackageIndex</index>
    </indices>
  </configuration>
  <reportSets>
    ...
  </reportSets>
</plugin>

An Index of Indices

If there are multiple indices on the page, you may also add an index over those indices. Use the showIndexOfIndices property as follows:

<plugin>
  <groupId>de.smartics.testdoc</groupId>
  <artifactId>testdoc-maven-report-plugin</artifactId>
  <version>${project.version}</version>
  <configuration>
    <showIndexOfIndices>true</showIndexOfIndices>
    <indices>
      <index>de.smartics.testdoc.report.index.UutPackageIndex</index>
    </indices>
  </configuration>
  <reportSets>
    ...
  </reportSets>
</plugin>