File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Question on javadoc 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 "Question on javadoc" Watch "Question on javadoc" New topic

Question on javadoc

Holmes Wong
Ranch Hand

Joined: Feb 18, 2002
Posts: 163
I have some basic questions on javadoc:
(1) Where should we put javadoc files?
Her is the path for my directories: home/scjd/suncertify/..., then I have three packages: db, server, client.
Should I put javadoc file under scjd directory?
(2) I am working on Linux. How can I create
javadoc files this way: the main html page includes all packages, clicking on individual packages can go to their own javadoc html files.
Mike Piotrowski
Ranch Hand

Joined: Apr 24, 2002
Posts: 82
My main directory had folders for
/docs - all javadoc stuff
/suncertify - client, server and db packages
/src - all source code
/mainfest - location of manifest files for
client and server
That main directory also had my client.jar and server.jar executable jar files. As well as my design choices document, README file, online instructions(html format) and db.db file.
As far as working with linux, the javadocs should be generated the same way. You can specify the sourcepath or destination path in the javadocs. From my main directory i used:

Holmes Wong
Ranch Hand

Joined: Feb 18, 2002
Posts: 163
Thank you very much, Mike. That was really helpful, I have thought about it for a while.
I gonna try it out. Thanks.
Another question about /src directory:
All source files will be put in this package, including unchanged files provided by SUN, right? Do we need to use the same directories, such as suncertify.db, suncertify.client, suncertify.server,... to include all .java files?
And class files for the project are in under suncertify directory with client, server, db pakgs, right?
A bit confused here.
[ June 30, 2002: Message edited by: Holmes Wong ]
Mike Piotrowski
Ranch Hand

Joined: Apr 24, 2002
Posts: 82
I kept all my source files in my /src folder. With one sub-directory for the original unmodified source files. I would compile them from that location with:

This would place the class files in their appropriate package. Those would be /suncertify/client, suncertify/db, and suncertify/server. Those files have to be in those directories.
If you wanted you could use the subdirectories under the /src folder for client, server, and db. I think I tried that though before I submitted and had a problem compiling something, so I just left it alone.
Holmes Wong
Ranch Hand

Joined: Feb 18, 2002
Posts: 163
Thanks, Mike. You really cleared up my doudbts.
I agree. Here's the link:
subject: Question on javadoc
Similar Threads
Submission Jar: test case + Ant build script
Recomended folder / package / class layout for javadoc
Javadoc ?
How do i run javadoc with packages?
Documentation Question