Javadoc reuse for overloaded methods
There is likely no good standard method, since even the JDK9 source code simply copy pastes large chunks of documentation around, e.g., at:
- http://hg.openjdk.java.net/jdk9/jdk9/jdk/file/07175dc5b2da/src/java.desktop/share/classes/java/awt/Container.java#l417
- http://hg.openjdk.java.net/jdk9/jdk9/jdk/file/07175dc5b2da/src/java.desktop/share/classes/java/awt/Container.java#l464
4 lines of comment are repeated. Yikes, non-DRYness.
I would just document your "fullest" method (in this case addTree(int,Fruit,int)
) and then in the JavaDoc for other methods refer to this one and explain how/which defaults values are used for the arguments not provided.
/**
* Works just like {@link ThisClass#myPow(double,double)} except the exponent is always
* presumed to be 2.
*
* @see ThisClass#myPow(double,double)
*/
static double myPow( double base );
I don't know of any support, but, I would fully javadoc the method with the most arguments, and then refer to it in other javadoc like so. I think it's sufficiently clear, and avoids redundancy.
/**
* {@code fruitType} defaults to {@link FruitType#Banana}.
*
* @see Forest#addTree(int, Fruit, int)
*/