Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Cloud/Virtualization forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc class description?

 
s yucel
Greenhorn
Posts: 11
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Pie
Posts: 11855
186
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
s yucel
Greenhorn
Posts: 11
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 11
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic