Как составить Javadoc для отдельных классов

Question

Я пишу Javadoc для класса, который содержит его собственные перечисления.Есть ли способ генерировать Javadoc для отдельных перечислений?Например, прямо сейчас у меня есть что-то вроде этого:

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

Однако, это только документирует все перечисления в целом:Любой способ документировать каждое из значений HairColor индивидуально?Не переводя перечисление в свой собственный класс или не заменяя его на перечисление?

Заранее спасибо за любую помощь.

Answer 1

Вы делаете это так же, как любая другая переменная, которую вы бы сделали javadoc.

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

    /**
     * Blue color
     */
    blue

}

РЕДАКТИРОВАТЬ:

От Paŭlo Ebermann: enum - это отдельный классВы не можете включить его полную документацию в включающий класс (по крайней мере, без исправления стандартного доклета).

Answer 2

Вы можете создать ссылку на каждый элемент перечисления.Все предметы будут перечислены в javadocs для перечисления класса.

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

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}