Eclipse Community Forums: Eclipse Platform » javadoc generation and ${tags}

Help

Home

Home » Eclipse Projects » Eclipse Platform » javadoc generation and ${tags} (javadoc generation and ${tags})

Show: Today's Messages :: Show Polls :: Message Navigator

javadoc generation and ${tags} [message #832532]

Fri, 30 March 2012 04:50

christophe seguinot is currently offline

christophe seguinot
Messages: 2
Registered: January 2012

Junior Member

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 ?

Thanks
Best regards,
Chris

Report message to a moderator

[Message index]

javadoc generation and ${tags}

By: christophe seguinot on Fri, 30 March 2012 04:50

Previous Topic:	Help Import website
Next Topic:	Maximize/restore a view programmatically

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Mon May 20 01:12:18 EDT 2013