package org.mutabilitydetector;

// TODO:  write javadoc
public enum IsImmutable {
    IMMUTABLE, EFFECTIVELY_IMMUTABLE, NOT_IMMUTABLE, COULD_NOT_ANALYSE;
}
@@ -31,109 +31,877 @@
 ;%0A%0A/
-/ TODO:  write javadoc%0Apublic enum IsImmutable %7B%0A    IMMUTABLE, EFFECTIVELY_IMMUTABLE, NOT_IMMUTABLE,
+**%0A * The various classifications for instances of classes.%0A * %0A * @author Grundlefleck at gmail dot com%0A *%0A */%0Apublic enum IsImmutable %7B%0A%0A    /**%0A     * Instances are perfectly immutable, can be safely published without extra synchronisation.%0A     */%0A    IMMUTABLE,%0A%0A    /**%0A     * Instances are only immutable when safely published. Extra synchronisation is required to publish effectively%0A     * immutable objects safely.%0A     */%0A    EFFECTIVELY_IMMUTABLE,%0A%0A    /**%0A     * Instances are not immutable, do not cache and/or share instances, do not publish to multiple threads, do not use%0A     * as keys in %7B@link HashMap%7Ds.%0A     */%0A    NOT_IMMUTABLE,%0A%0A    /**%0A     * Instances can be any of %7B@link #IMMUTABLE%7D/%7B@link IsImmutable#IMMUTABLE%7D/%7B@link #NOT_IMMUTABLE%7D, however, an%0A     * internal error has occurred during analysis, and no result is meaningful.%0A     */%0A   
  COU
@@ -917,8 +917,9 @@
 ALYSE;%0A%7D
+%0A

Add javadoc to IsImmutable