Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

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?

like image 768
Snowy Coder Girl Avatar asked Jul 01 '11 15:07

Snowy Coder Girl


2 Answers

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).

like image 90
user489041 Avatar answered Sep 28 '22 13:09

user489041


You can create link to each enum's item. All items will be listed in javadocs to enum class.

/**  *  Colors that can be used  *  {@link #RED}  *  {@link #BLUE}  */ public enum Color {      /**      * Red color      */      RED,      /**      * Blue color      */     BLUE } 
like image 32
shushper Avatar answered Sep 28 '22 13:09

shushper