Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

The deliverables of the project

 
David Rocks
Ranch Hand
Posts: 162
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In the deliverables section of the spec it states that i should include a high level description of each file that i have submitted. My question really is how far do i have to take this.
I have 26 classes in my completed project under a source directory. I also have my javadocs and then my classes(which i suppose i could jar up). This could be a long tedious job. can they not look in the java docs for a description of the source?
can anybody who has completed the project tell me how they went about this. if it is not to big a job i can upload it in tomorrow.
cheers in advance
 
Matt DeLacey
Ranch Hand
Posts: 318
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I gave a one sentence description of each of the files, the exception being all the javadocs files. I just pointed them to the directory where I put them all and said these are all the docs generated by javadoc...it seemed like overkill to me to say
Data.html the javadoc file for class Data
FieldInfo.html the javdoc file for class FieldInfo
and so on...that's pretty self-explanatory to me.
All of the classes you have generated I think you would be wise to descibe.
With Respect,
Matt
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic