Search code examples
javaenumsjavadoc

How to Javadoc a Class's Individual Enums

I am writing the Javadoc for a class that contains its own enums. Is there a way to generate Javadoc for the individual enums? For example, right now I have something like this:

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

However, this only documents all of the enums as a whole:

The generated Javadoc

Is there any way to document each of the HairColor values individually? Without moving the enum into its own class or changing it from an enum?

Solution

  • You do it just like any other variable you would javadoc.

    
/**
 *  Colors that can be used
 */
public enum Color
{
    /**
     * Red color
     */
    red,

    /**
     * Blue color
     */
    blue

}

    EDIT:

    From Paŭlo Ebermann : The enum is a separate class. You can't include its full documentation in the enclosing class (at least, without patching the standard doclet).