Search code examples
javadoc

javadoc parameter without package name


Basically, eclipse export javadoc output format such as:


    Method
    Modifier and type        Method and description
    java.lang.String         getData(java.lang.String key)
    java.lang.String         echo(java.lang.String string) 
    ...

If i wanna another format such as:

    Method
    Modifier and type        Method and description
    String                   getData(String key)
    String                   echo(String string) 
    ...

(without package name)

what should i do in the eclipse javadoc Extra javadoc options item? many thanks.


Solution

  • I'm not sure how one does configure this in Eclipse, but the standard doclet has the -noqualifier option.

    If you don't want any package names to be shown, you can use -noqualifier all, if you only want some package names to be omitted, you can list these, like this: -noqualifier java.lang:java.io.

    Note then in these cases it is a good idea to also have a -link or -linkoffline option linking to the documentation of these classes, so readers have a chance to find out which class is meant here.