Where should a tag be placed to be considered in the report?

A tag has to be preceded by either "*" or "//", ignoring whitespace, i.e. it has to be inside a single-line or mulit-line JavaDoc comment. Otherwise it will be ignored in the report.

For examples of this, see the counting tags document.

[top]

When is a tag included in the report?

For examples of this, see the counting tags document.

[top]

Why do I get an error stating the Taglist plugin must must be exeucted after the JXR plugin?

The error message: "[ERROR] Taglist plugin MUST be executed after the JXR plugin. No links to xref were generated." is logged when the Taglist plugin is executed before the JXR (source cross-reference generator) plugin. The Taglist plugin creates links in its report to the xref or test-xref files when tags are found; however, if the JXR plugin has not been executed, the Taglist plugin cannot create the links.

Some causes of this condition:

  • POM plugin order: the JXR plugin must be listed before the Taglist plugin in the POM or inherited POM reporting section.
  • Maven bug: in some versions of Maven, the report plugins execution order is erroneously changed from the order defined in the POM file. Please follow the JIRA issue for more information and updated status.

To resolve this error, check that the report plugins order is correct in the POM. If you cannot modify the POM order, or if doing so does not resolve the problem, a workaround is to execute the "site" goal twice. The first time you will receive the error and no links will be created, but the second pass will be successful because the xref files already exist.

[top]