Is it possible to get the same doc for overloaded methods?

Question

I'm searching the best way to make documentations with overloaded methods.

I have two methods:

/**
* does something
* @param A
* @return result
*/
public String methodA(Type1 A);

/**
 * does something
 * @param A
* @return result
*/
public String methodA(Type2 A);

Since both methods render the same thing, is it possible to centralize the doc on a method which would take Object arguments? Or is there a better way to do so?

You could use generics but I guess this is a bit heavy handed for centralising documentation! — T. Kiley, Jun 18 '13 at 08:53
The Javadoc has no such mechanism, no... One has to check for the method arguments. — fge, Jun 18 '13 at 08:55
You could use the http://stackoverflow.com/questions/5915992/javadoc-writing-links-to-methods `@link` tag to link one of the methods to the other. This avoids redundancy of the actual documentation ("does something"). — Andreas Fester, Jun 18 '13 at 09:00

Andreas Fester · Accepted Answer · 2013-06-18T09:14:47.630

1

I think that your original intention to write a kind of "generic" documentation does not work out of the box. You need to take care of the parameters and the return value at least.

Or is there a better way to do so ?

To avoid redundancy of the actual documentation, you can use the @link tag.

This is especially useful if the method requires a lot of documentation, like for example the Properties.load() methods.

edited Jun 18 '13 at 09:14

answered Jun 18 '13 at 09:09

Andreas Fester

36,091
7
95
123

Is it possible to get the same doc for overloaded methods?

1 Answers1