JAVA

java docstring javadoc

/**
 * <p>This is a simple description of the method. . .
 * <a href="http://www.supermanisthegreatest.com">Superman!</a>
 * </p>
 * @param incomingDamage the amount of incoming damage
 * @return the amount of health hero has after attack
 * @see <a href="http://www.link_to_jira/HERO-402">HERO-402</a>
 * @since 1.0
 */
public int successfullyAttacked(int incomingDamage) {
    // do things
    return 0;
}

javadoc reference general toString

/**
 * This javadoc text will reference Object's 
 * {@link java.lang.Class#toString()} method.
 */
 
// Output in Javadoc:
// This javadoc text will reference Object's Class.toString() method.