aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes javadoc class description? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "javadoc class description?" Watch "javadoc class description?" New topic
Author

javadoc class description?

s yucel
Greenhorn

Joined: Dec 04, 2005
Posts: 11
Hi all,
having completing the comments in the applcation, I run the javadoc tool.But it does not seem to be generating the class/interface summary section at the top of the each class/interface. Does not it normally generate? or I am missing some parameter?

Secondly, I would like to write my design decisions in the document. Probably, I need to write why I choosed socket implementaion instead of RMI. The actaul reason is that I know the socket impl. very well. So what shoudl I write?

any idea highly appreciated.

kind regards,
Andrew Monkhouse
author and jackaroo
Marshal Commander

Joined: Mar 28, 2003
Posts: 11483
    
  94

Hi,

Perhaps you could post the block of code between the 'package ...' and the 'public class ...' sections of one of your classes so we can see what your JavaDoc looks like. JavaDoc should extract the summary from there.

If you are talking about package level summaries though, that is a different matter.

Regards, Andrew


The Sun Certified Java Developer Exam with J2SE 5: paper version from Amazon, PDF from Apress, Online reference: Books 24x7 Personal blog
s yucel
Greenhorn

Joined: Dec 04, 2005
Posts: 11
Hi,
a sample code is as follows:

/**
* Data is the class where the database file is mount and opened and
*................................................
* @author Serkan YUCEL
*/

package suncertify.db;
.
.
.

The problem is when I generate javadoc, it does not generate the comments which stays at the beginning of each class. I might be missing some options but I do not know.

kind regards,
s yucel
Greenhorn

Joined: Dec 04, 2005
Posts: 11
I should have written the class comments just before the class definition, otherwise it assumes like package comments. so it is ok now.
thanks

kind regards,

s. yucel
 
 
subject: javadoc class description?