Using @see tag in Javadoc

[Mark O' Sullivan]

Hi,
Could someone provide me with an example of how to use the @see tag of Javadoc when commenting upon a function in a class and using the tag to refer to a different function but within the same class?
Thanks.

[Roberto Perillo]

Howdy, Mark!

/**
 * Does something really cool. This method is great!
 *
 * @see #anotherCoolMethod()
 */
public void coolMethod(String name) {
    // Doing something cool...
}

Where anotherCoolMethod() is another method that is in the same class as the coolMethod(String) method.

[Mark O' Sullivan]

Cheers, thanks very much for the reply Roberto!

[Roel De Nijs]

Hi Mark,

A great resource for information is "How to Write Doc Comments for the Javadoc Tool" or just click here.

And another great resource is "javadoc - The Java API Documentation Generator", you can find it here.

Kind regards,
Roel