What's the correct way to include an email within Javadoc?

Viewed 14748

I like to put my email address within @author tags and would like them to be clickable mailto: links in the generated Javadoc.

How should I go about doing this correctly?

/**
 * I currently do the following, but would like to have my name 
 * displayed as the link rather than the email itself.
 *
 * @author {@link "mailto:my_email@email.example.com"}
 */
public class Useless { }

/**
 * I've tried this, but get warnings about unexpexted text where my name is.
 *
 * @author {@link "mailto:my_email@email.example.com" "Benoit St-Pierre"}
 */
public class Useless { }
1 Answers
Related