JavaDoc: Reduce redundancy for Repeated Method Descriptions
For example, i have two methods, public Tree<T> addChild(final T data) {}
and public Tree<T> addChild(final T... data) {}, their JavaDocs are
identical. How to put the /** method description */ in one of them, and
use a tag to refer another JavaDoc to the previous one?
Just like, in concept:
/**
* method description
*/
public Tree<T> addChild(final T data) { ... }
/**
* @theTag #addChild(Object)
*/
public Tree<T> addChild(final T... data) { ... }
If i remember it correctly, i once accidentally came across a tag, which
imports the entire method description of a Java native API method. So, it
should be possible.
What is @theTag? Thanks very much!
No comments:
Post a Comment