General Documentation for Users

The following general documentation is available.

Quickstart

The Quickstart documentation shows how to get the whole thing going.

You may also have a look at the general FAQs.

Best Practices

The Best Practices documentation lists best practices in error handling, logging, tips, and using smart-exceptions.

References

Most of the information found on this web site has already mentioned elsewhere. Some authors have a different opinion on certain topics (e.g. checked exceptions). We list references to the information we used on the References page.

Howtos for Modules

The following Howtos are available. Each module documents the features it provides.

Howto use core

The Howto for the core module describes how to use the core features of smart-exceptions.

You may also have a look at the module's FAQs.

Howto use i18n

The Howto for the i18n module describes how to use the I18N features of smart-exceptions.

You may also have a look at the module's FAQs.

Howtos for Reports

The following Howtos to generate Reports are available.

Howto use maven-exceptioncodes-plugin

The Howto for the Maven report plugin describes how to generate an exception code report.

You may also have a look at the module's FAQs.

Howto use Ant Task

The Howto for the ant task describes how to generate an exception code report.

Howto use CLI

The Howto for the ant task describes how to generate an exception code report.

Documentation for Developers

For those that want to download and enhance the sources or add report generators for other build environments than Maven the following documentation is provided.

Subprojects for Developer

The Subprojects for Developer given an overview on the modules that are relevant only to developers.

Please also refer to the aggregated reports and the reports provided by the modules themselves.