tiene - Cómo Javadoc las clases individuales de una clase

javadoc wiki

Question

Estoy escribiendo el javadoc para una clase que contiene sus propias enumeraciones. ¿Hay una manera de generar javadoc para las enumeraciones individuales? Por ejemplo, ahora mismo tengo algo como esto:

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

Sin embargo, esto solo documenta todas las enumeraciones en conjunto:

¿Hay alguna forma de documentar cada uno de los valores de HairColor individualmente? ¿Sin mover la enumeración a su propia clase o cambiarla de una enumeración?

Gracias de antemano por cualquier ayuda.

Answer 1

Lo haces como cualquier otra variable que javadoc.

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

    /**
     * Blue color
     */
    blue

}

EDITAR:

De Paŭlo Ebermann: La enumeración es una clase separada. No puede incluir su documentación completa en la clase adjunta (al menos, sin parchar el doclet estándar).

Answer 2

Puede crear un enlace a cada elemento de enumeración. Todos los artículos se enumerarán en javadocs a enum class.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}