Meaningless Drivel is fun!*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Javadoc question Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Android Security Essentials Live Lessons this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Javadoc question" Watch "Javadoc question" New topic
Author

Javadoc question

Vishnu Sri
Greenhorn

Joined: Jul 28, 2005
Posts: 4
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

Joined: Apr 07, 2005
Posts: 232
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.


----------------------------------<br />| SCJP, SCWCD, SCBCD, SCEA, SCJD |<br />----------------------------------
Vishnu Sri
Greenhorn

Joined: Jul 28, 2005
Posts: 4
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

Joined: Apr 07, 2005
Posts: 232
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

Joined: Mar 12, 2007
Posts: 92

Hi Lucy,

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

Thanks,

Romeo


SCJP 1.4, SCJD, OCE EJBD 6
Mihai Radulescu
Ranch Hand

Joined: Sep 18, 2003
Posts: 916

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


SCJP, SCJD, SCWCD, OCPJBCD
Romeo Son
Ranch Hand

Joined: Mar 12, 2007
Posts: 92

Thanks Mihai!
 
 
subject: Javadoc question
 
Similar Threads
how to read int or any input value entered in console using DataInputStream??
data type for large decimals
Generate HTML javadocs from jars
List of deprecated APIs in Java 1.5
Formatting