• Post Reply Bookmark Topic Watch Topic
  • New Topic

javadoc

 
Fred Barnes
Ranch Hand
Posts: 62
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Guys,
Do I only javadoc public methods and fields?
Or do I javadoc all protected, private and default memebers? Is it nessesary to javadoc all variables, for e.g. JPanel in the GUI?
Regards
Fred
 
Bernhard Woditschka
Ranch Hand
Posts: 89
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I documented public and protected methods.
As that's the potential user of my API will see.
Bern
 
Happiness is not a goal ... it's a by-product of a life well lived - Eleanor Roosevelt. Tiny ad:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!