Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleDescription
The mojo generates an index of packages and folders within the classpath of a project. This index is stored within the artifact at META-INF/INDEX.LIST.
Section
titlePrerequisites

Section
titleAbstract

Section
titleBasic Configuration

To create the index for a project, use this configuration:

Code Block Placeholder
code-languageHTML and XML
<plugin>
    <groupId>${project-group-id}</groupId>
    <artifactId>${project-artifact-id}</artifactId>
    <version>${project-version}</version>  <executions>
    <execution>
      <id>index</id>
      <goals>
        <goal>index</goal>
      </goals>
    </execution>
  </executions>
</plugin>
Abstract
Section
titleSelected Files

To select certain files, use the fileSets configuration:

Code Block Placeholder
code-languageHTML and XML
<plugin>
  <groupId>${project-group-id}</groupId>
  <artifactId>${project-artifact-id}</artifactId>
  <version>${project-version}</version>  <executions>
  <executions>
    <execution>
      <id>index</id>
      <goals>
        <goal>index</goal>
      </goals>
      <configuration>
        <fileSets>
          <fileSet>
            <directory>${project.build.outputDirectory}</directory>
            <excludes>
              <exclude>META-INF/**</exclude>
            </excludes>
          </fileSet>
        </fileSets>
      </configuration>
    </execution>
  </executions>
</plugin>

If no directory is given, it defaults to project.build.outputDirectory.

Section
titlePrerequisites
Section
title

Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
sort-bySort Key, Name
restrict-to-immediate-childrentrue

...