From: Egon Willighagen <egon.willighagen@gm...> - 2009-03-10 09:46:31
this is just a short reminder about the use of @cdk.bug in the JavaDoc
annotation of CDK classes and their unit tests.
Annotation in the CDK classes itself, is to make it visible to people
reading the JavaDoc that this class is affected by that particular
bug. So, when that bug is fixed, the @cdk.bug annotation can be
However, the @cdk.bug annotation in the unit tests has a different
purpose. There is indicates that a particular unit test is written for
that bug. This @cdk.bug annotation should never be removed, but allows
us to link unit tests to bug reports for future reference, such as the
case when the unit test fails again. Then the bug report serves as
documentation of why that unit tests was written.
Post-doc @ Uppsala University