Module org.apache.sis.util
Package org.apache.sis.util

# Annotation Interface Debug

@Documented @Target({TYPE,METHOD,FIELD}) @Retention(SOURCE) public @interface Debug
Annotates classes or methods that are provided mostly for debugging purpose. This annotation is defined in order to make easier to find which debugging tools are available in case of problem. See the "Use" javadoc link for a list of annotated classes and methods.

Unless specified otherwise in javadoc, `Object​.toString()` method implementations in Apache SIS are implicitly for debugging purpose. Those methods are usually not annotated with `@Debug` in order to avoid polluting `@Debug` usage searches with long lists of `toString()` methods. As an exception to this convention, a `toString()` method may be annotated with `@Debug` in a few cases where we want to put emphasis on the method purpose as a debugging tools.

Since:
  0.3