Javadoc - cannot compile @param tags

[jon80]

Does anyone know the syntax for including @param tags within the generated javadoc documents?

:confused:

I searched high and low but could not find this information in the documentation and command line help, in a manner that I could understand it.

[OrangeDog]

Have a look at the Java API source code for numerous examples.

[jon80]

API source code?

[Singing Boyo]

This should help you

/**These are the Javadoc comments.  They use a slash
 * two asterisks, comments/tags, an asterisk, and another
 * slash.  They describe the method after them
 * 
 * @param s the parameter of this method
 */
public void myMethod(String s){
	//method code
}

The asterisks on each line are not necessary, only the /** and */ at the beginning and end. Note that all tags must be at the end of the comment, after the description

[Eranga]

API source code?

Didn't you ever seen Java API source code? Check for a zip file named src inside the Java installation folder.

[Singing Boyo]

Lol... personally, I would never try looking through Java source. Too much for me, and I don't really want to see the original Java code. I do have plenty of code with Javadoc comments though, if my earlier post didn't help.

[Eranga]

Sometime it useful to me lol. Looking at the source code, I'm able to find different logic in developments.

[jon80]

Presume you're talking about

..\jdk1.6.0_13\src.zip which I had extracted to ..\src

lol it sure does contain numerous sub-folders

Anyway I checked my code (again) and it just seems correct. I don't see a description of the @param. The funny thing is that the javadoc generated excludes one of the classes (Employee), and that there is a warning icon next to the class within Eclipse (even though it compiles when running the project).

/*
	 * @param employee - any object of the Employee class.
	 */
	//5. Operators
 @Override public boolean equals (Object anotherObject) 
	{

[Eranga]

Presume you're talking about

..\jdk1.6.0_13\src.zip which I had extracted to ..\src

lol it sure does contain numerous sub-folders

Anyway I checked my code (again) and it just seems correct. I don't see a description of the @param. The funny thing is that the javadoc generated excludes one of the classes (Employee), and that there is a warning icon next to the class within Eclipse (even though it compiles when running the project).

/*
	 * @param employee - any object of the Employee class.
	 */
	//5. Operators
 @Override public boolean equals (Object anotherObject) 
	{

Yes, it contains large number of sub-folders. All of them are packages you are using in your applications, using import statement.

[Singing Boyo]

Your parameter is non-existant. That would cause problems. Also, double asterisk at the beginning (/** instead of /*) for Javadoc. Single asterisk is for regular comments.