Comment Javadoc des classes individuelles

J’écris le javadoc pour une classe qui contient ses propres énumérations. Existe-t-il un moyen de générer du javadoc pour les énumérations individuelles? Par exemple, j’ai maintenant quelque chose comme ça:

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

Cependant, cela ne documente que toutes les énumérations dans leur ensemble:

Le Javadoc généré

Est-il possible de documenter chaque valeur de HairColor individuellement? Sans déplacer l’enum dans sa propre classe ou le changer à partir d’un enum?

Merci d’avance pour votre aide.

Vous le faites comme n’importe quelle autre variable 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 }

MODIFIER:

De Paŭlo Ebermann: L’énumération est une classe séparée. Vous ne pouvez pas inclure sa documentation complète dans la classe englobante (du moins, sans patcher le doclet standard).

Vous pouvez créer un lien vers l’élément de chaque enum. Tous les éléments seront listés dans javadocs à enum class.

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