Win a copy of Five Lines of Code this week in the OO, Patterns, UML and Refactoring forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

Question on javadoc

 
Ranch Hand
Posts: 163
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
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.
Thanks.
 
Ranch Hand
Posts: 82
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Holmes,
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:

MIKE
 
Holmes Wong
Ranch Hand
Posts: 163
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 82
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
Mike
 
Holmes Wong
Ranch Hand
Posts: 163
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks, Mike. You really cleared up my doudbts.
 
Don't get me started about those stupid light bulbs.
    Bookmark Topic Watch Topic
  • New Topic