IntelliJ Java IDE
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Guidance required for javadoc Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login
JavaRanch » Java Forums » Professional Certification » Developer Certification (SCJD/OCMJD)
Reply Bookmark "Guidance required for javadoc" Watch "Guidance required for javadoc" New topic
Author

Guidance required for javadoc

Devu Shah
Ranch Hand

Joined: Jun 21, 2001
Posts: 50
1. when i generate doc files by javadoc command i get warning messages for not including @serial tag for the default serialisable fields.
I tried a lot of ways but cant get rid of the problem could anyone tell me the solution ?
2. do we have to generate javadocs for all the diff packages we have created i.e in my case client,server,db

3. do we have to make seperate packages for source and class files or they have to be packed in the same package with their respective java files.
In my case i use the db package for both server and client that means i have to duplicate the same thing two times for both the package?

Please kindly give me clear guidelines.
SMK Reddy
Greenhorn

Joined: Jun 03, 2001
Posts: 20
For your 2 question,
in Deliverables bullet 3: "You must provide HTML/Javadoc documentation for all classes, whether supplied, modified, or new."
For your 3 Question
in my case, I have packaged source and class files together in each package
Regards
SMK Reddy
Kevin Yip
Ranch Hand

Joined: Oct 17, 2000
Posts: 110
Regarding packing the "supplied, modified, or new" sources or classes:
Would somebody advise whether we should separate the 3 types in 3 directories or just mixing together in a single directory is fine?
Catherine McManus
Greenhorn

Joined: Oct 23, 2000
Posts: 19
Kevin
I am providing a classes directory containing the required class files. I am not separating out "supplied, modified, or new" but just putting them where they need to be to run the programs.
And I am providing a source directory containing the source with the same structure as the directory containing the classes.
I think this does not break the requirements which were not specific as to where to actually put the files.
Catherine
Akanimo Udoh
Ranch Hand

Joined: Jun 11, 2001
Posts: 48
Kevin,
Catherine's correct. Your source and compiled files should just be a submission of the current working set of files for your program. No need to divide them up separately and duplicate files. The current working set will contain the unmodified files, as well as your new and the modified files, which is what is required.
Akanimo.
 
 
subject: Guidance required for javadoc
 
Threads others viewed
Client Server Packaging !
Documentation Question
Question on javadoc
looking for SCJD checklist!!
javadoc for generating api's
MyEclipse, The Clear Choice