• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc problem

 
James Du
Ranch Hand
Posts: 186
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Some of the Javadoc documentation in the original source files provided by sun do not include @param or @return tags. should i supplement it? what's your comment?
Thanks in advance
James
 
jyothi sunke
Ranch Hand
Posts: 65
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yeah u can supply those tags to the supplied classes...and as u also need to supply unmodified supplied classes, it doesn't gives any problem.
 
James Du
Ranch Hand
Posts: 186
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
But I learned form the posts here, that you should modify the supplied class the least, unless in the case where you have to.
Do you think the javadoc is an exception?
James
 
Dan Collins
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I think it is a good idea to make sure the supplied code is up to the JavaDoc standards. Just make sure that you keep an unmodified copy of the code that you submit back to Sun.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic