This week's book giveaway is in the Performance forum.
We're giving away four copies of The Java Performance Companion and have Charlie Hunt, Monica Beckwith, Poonam Parhar, & Bengt Rutisson on-line!
See this thread for details.
Win a copy of The Java Performance Companion this week in the Performance forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc question

 
Vishnu Sri
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ranchers,

I am close to submitting. I've a doubt about javadoc generation.

The instruction says that the javadoc must be generated using javadoc tool.
Does this mean that I can't use my IDE to generate the full javadoc documentation?

When I use the javadoc on command line, the generated document is missing some classes:

Here is the command I typed:

javadoc -verbose -link http://java.sun.com/j2se/1.5.0/docs/api -d doc\javadoc -sourcepath code -public suncertify.db suncertify.gui suncertify.remote

If I use the IDE it is generating javadoc for all the classes.

Thanks in advance for your help...

Vishnu
 
Lucy Hummel
Ranch Hand
Posts: 232
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I think you should provide javadoc for all classes.

Under the topic building with ant you find some ant script that I used.

Note: Still some adjustment have to be done.
 
Vishnu Sri
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Hummel,

Thanks for your response. I could generate the javadoc.

I have one more question: If I use {@inheritDoc} tag, it only says specified by and points to the interface method.

But some forumers have mentioned that the comments of the interface will be copied.

I am concerned because the instruction says all classes must have javadoc comment.

Shall I just avoid the inheritDoc tag and just copy the same comments?

Thanks in advance for any help..

Vishnu

Vishnu
[ May 23, 2007: Message edited by: Vishnu Sri ]
 
Lucy Hummel
Ranch Hand
Posts: 232
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Vishnu,

In case the base classe or interface is available the {@inheritDoc} is working. Otherwise not.

Available means it was one of my own class or interface.

At least that was so in my case.

Just try and see what the result is.
 
Romeo Son
Ranch Hand
Posts: 92
Android Eclipse IDE Suse
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Lucy,

Have you provided package descriptions for JavaDoc? Do you know how it can be accomplished?

Thanks,

Romeo
 
Mihai Radulescu
Ranch Hand
Posts: 918
IntelliJ IDE Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Romeo

to provide package documentation you need to have in each of your package a file named : package-info.java, for more details take a look at :
http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html - just search in this document for "package-info.java" and you'll find the right info.

Regards,
M
 
Romeo Son
Ranch Hand
Posts: 92
Android Eclipse IDE Suse
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks Mihai!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic