• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Should I document generated stub?

 
Tim Chang
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,
I'm working on document my assignment, I got confused for this:
"javadoc style comments must be used for each element of the public interface of each class."

The stub class generated by rmic is public, so I have a stupid question, should I have to document it?

PS: English is not my native language, so if there has any unwell sentenses please excuse me.

Thanks in advance.
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Tim,

Welcome to JavaRanch and this forum.

There is no need to document the stubs or skeletons - nobody should ever call (or need to lookup the APIs for) these classes.

Regards, Andrew
 
Tim Chang
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Andrew,
Thanks for your comment, you gave a clear explanation for me.

Regards, Tim.
[ February 20, 2005: Message edited by: Tim Chang ]
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic