Is there a javadoc tag for documentating generic type parameters?

Question

I've been looking through the javadoc documentation on Sun's site, trying to find if there's a javadoc tag which can be used to document a class or method's generic type signature.

Something like @typeparam, similar to the usual @param, but applicable to types as well as methods,e.g.

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}

I suspect there is no such tag - I can find no mention of it anywhere, and the JavaSE API docs don't show any sign of it, but it seems like an odd omission. Can someone put me right?

Answer 1

It should be done just like this:

/**
 * @param <T> This describes my type parameter
 */
class MyClass<T>{

}

Source

Answer 2

Yes. Just use the @param tag, and include angle brackets around the type parameter.

Like this:

/**
 *  @param<T> This describes my type parameter
 */

Answer 3

I don't think this omission is odd. By virtue of being a generic type (erased at runtime), the type parameter is really not part of the api.

If you are concerned about the essence of the type itself and want to document it, perhaps you need to restrict it (e.g. MyClass <T extends MyType>)?