Frequently Asked Questions

General

  1. What is this project all about?
  2. Is there an example report available?
  3. What are the system requirements of this plugin?
  4. What is the difference between smart-exceptions and smartics-exceptions?

Configuration

  1. How may I reference the Javadoc report aggregated in the parent project.

Implementation

  1. I want to alter the content of the Maven report output. How can I do that?
  2. I want to alter the output, but I am not using Maven. What should I do?

General

What is this project all about?
With smartics-exceptions the developers code and comment exception codes. This project runs through the class and source tree and collects the codes and descriptions to generate site and XML reports.

[top]

Is there an example report available?
Yes, we provide examples for

[top]

What are the system requirements of this plugin?
We require Java 6 or above. The plugin is tested with Maven 3. We do not test, if it runs with older versions.

[top]

What is the difference between smart-exceptions and smartics-exceptions?
smartics-exceptions is the new version of smart-exceptions. We simply changed the artifact ID from version 0.6.2 to 0.7.0 (besides other changes).

[top]

Configuration

How may I reference the Javadoc report aggregated in the parent project.
A little wired, but supposing that the apidocs are in the parent directory, you specify the reference from the exception report to that directory like this: 
<javadocDir>${project.reporting.outputDirectory}/../apidocs</javadocDir>

[top]

Implementation

I want to alter the content of the Maven report output. How can I do that?
Provide a subclass of AbstractSinkReportGenerator class.

You may want to consider the implementation of PackageSortedSinkReportGenerator and CodeSortedSinkReportGenerator as examples.

The register your report in the exceptioncodes-maven-plugin configuration like this:

Please refer to Using the Report and Plugin documentation (especially Mojo exceptioncodes:report) for further information about configuration of the plugin.

[top]

I want to alter the output, but I am not using Maven. What should I do?
There is a project that provides some code stubs to implement reporting without references to Maven. Please refer to the documentation of the project smart-exceptions-report for details.

[top]