• 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
  • Paul Clapham
  • Jeanne Boyarsky
  • Junilu Lacar
  • Henry Wong
Sheriffs:
  • Ron McLeod
  • Devaka Cooray
  • Tim Cooke
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Frits Walraven
  • Tim Holloway
  • Carey Brown
Bartenders:
  • Piet Souris
  • salvin francis
  • fred rosenberger

Guidance required for javadoc

 
Ranch Hand
Posts: 50
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Greenhorn
Posts: 20
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Ranch Hand
Posts: 110
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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?
 
Greenhorn
Posts: 19
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
Ranch Hand
Posts: 48
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Don't sweat petty things, or pet sweaty things. But cuddle this tiny ad:
Devious Experiments for a Truly Passive Greenhouse!
https://www.kickstarter.com/projects/paulwheaton/greenhouse-1
    Bookmark Topic Watch Topic
  • New Topic