Is it possible to re-use @param descriptions in JavaDoc?

Question

I have a convenience class for encoding URI's. In it I've created three methods which I use depending on how specific I need to be. I'm wondering if there is a smart way to re-use @param descriptions in this case using JavaDoc? (I haven't found any)

public class URLCreator {
    public static String getURLString(String host, int port, String path) {
        return getURLString("http", host, port, path, null);
    }
    public static String getURLString(String scheme, String host, int port, String path) {
        return getURLString(scheme, host, port, path, null);
    }
    public static String getURLString(String scheme, String host, int port, String path, String fragment) {
        try {
            URI uri = new URI(scheme, null, host, port, path, null, fragment);
            return uri.toString();
        } catch (URISyntaxException e) {
            throw new RuntimeException(e);
        }
    }
}

Duplicate question: http://stackoverflow.com/questions/7021696/javadoc-reusable-parameter-values — Mark Butler, Feb 13 '13 at 15:43
@MarkButler this one is much more succinct and easier to read though, but you're right — Hilikus, Oct 31 '13 at 15:33
This is the closest to an answer I could find: https://stackoverflow.com/a/30103339/9768291 — payne, Oct 17 '19 at 23:50

score 0 · Accepted Answer · answered Jun 25 '09 at 06:09

0

No. Copying works for overridden, but not for overloaded methods. http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html#inheritingcomments

answered Jun 25 '09 at 06:09

Mikko Maunu

41,366
10
132
135

Yep, I know about the inheritence behavior. I select it as the preferred answer for the "No." part. :-) – Jun 30 '09 at 17:53
Try the @see tag: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@see – Eran Medan Nov 17 '12 at 03:25

Is it possible to re-use @param descriptions in JavaDoc?

1 Answers1

Linked