How Javadoc Class Individual Enumerations

Question

I am writing javadoc for a class containing its own enumerations. Is there a way to generate javadoc for 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 the listings in general:

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

Thanks in advance for your help.

Answer 1

You do this just like any other variable that you will javadoc.

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

EDIT:

From Paŭlo Ebermann: Enumeration is a separate class. You cannot include your full documentation in the inclusion class (at least without fixing the standard doclet).

Answer 2

You can create a link to each listing item. All elements will be listed in javadocs to enumerate the class.

 /** * Colors that can be used * <li>{@link #RED}</li> * <li>{@link #BLUE}</li> */ public enum Color { /** * Red color */ RED, /** * Blue color */ BLUE }