eclipse, javadoc and ${tags}

[christophe seguinot]

Hello,

In the javadoc template of a method (java -> Code Style -> Code Template : Comments -> Methods) we can have :

/**
* ${tags}
*/

Take the following example :

private String generateJavaDoc(String exemple) {
return "javadoc";
}

By clicking on ctrl + shift + j, we get :

/**
* @param exemple
* @return
*/
private String generateJavaDoc(String exemple) {
return "javadoc";
}

Extract form the eclipse documentation :

"Comment templates can contain the variable ${tags} that will be substituted by the standard Javadoc tags (@param, @return..) for the commented element."

I would like to customize the template associated to @{tags} in order to add the @link tags.

/**
* @param exemple {@link String}
* @return {@link String}
*/
private String generateJavaDoc(String exemple) {
return "javadoc";
}

Does anyone know how to do this or at least if it's possible or maybe the name of the eclipse plugin which is used, some clue perhaps ?

Thanks
Best regards,
Chris

[Tim Holloway]

Making a template like what you described is easy. Making the link target point somewhere requires that something be able to figure out where that "somewhere" is going to be.

If you were actually just planning to link to the parameter's datatype javadocs, the link tag would be redundant, since the normal javadoc generator already does that.

[B Kelly]

Similar question: I'd like to customize ${tags} in auto-generated constructors to reference javadoc I write for fields set in the constructor. I do something similar for auto-getters and setters:

/**
* Get the ${bare_field_name}.
* @return the ${bare_field_name}
* @see #${bare_field_name}
*/

/**
* Set the ${bare_field_name}.
* @param ${param} input ${bare_field_name}
* @see #${bare_field_name}
*/

This would be a big time saver, as I would only have to document the fields once instead of repeat or copy paste for multiple constructors. Any straightforward way to do this?

[Tim Holloway]

Welcome to the JavaRanch B,

Actually, rather than raising a dead topic (zombie), we'd prefer that you start a new one.

It's very easy to customize the autodocs in Eclipse. Just go to Help/Preferences, select Java, Code Style, Code Templates. The items in question are "fields", "getters" and "setters". These are the templates that are used when generating properties and accessor/mutator methods.