[rakesh.gaddam]

Hello,

I am developing an application in struts using myeclipse.I created the javadocs for it.Is there any parameter(like @return, @throws) for example.I just wanted to give in a brief example for some of the methods.

When I give an example in the comments,all the lines of the example are getting appended in one line as:

Example String originalDate = “04/17/06”; String currentFormat = “mm/dd/yy”; String newFormat = “EEE MMM dd, yyyy hh:mm:ss aa zzz”;

Can you let me know if there is a way where I could separate the example section in the javadoc after giving a brief description,parameters,return and throws.

Thanks
Rakesh.

[Riyad Kalla]

Moving to OT > Soft Dev

Rakesh,
There are not explicit tags for an example, you just want to HTML format your javadocs like this:

/**
* This method does something.
* <p>
* Use it like this:
* <pre>
* MyClass.someMethod("Bob");
* </pre>
* @param o The object to pass in.
* @return an object that does something.
*/
public static Object someMethod(Object o);

[Author]

Posts