Win a copy of Java 9 Revealed this week in the Features new in Java 9 forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

NX: Default Class Visibility  RSS feed

 
Chin Ho Tan
Greenhorn
Posts: 8
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I have implements the Data class using another two helper classes, namely PersistManager and LockManager. I would like to set the visibility of these two helper classes to default. But then I would not have the javadoc generated for these two helper classes. Is that OK ?
Thanks.
 
Jim Yingst
Wanderer
Sheriff
Posts: 18671
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You can invoke javadoc with the -package option, and it will document package-level (default access) elements as well as proteded & public.
 
Chin Ho Tan
Greenhorn
Posts: 8
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you !!
 
Chin Ho Tan
Greenhorn
Posts: 8
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
Is it a good idea to put the private members and private methods in the javadoc ?
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Posts: 12100
246
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Chin Ho
I created javadoc for all my methods and variables, no matter what access they had. However I ran javadoc with standard arguments - so I did not generate javadoc for private methods.
This seemed to work for me - I got 100% on my documentation.
Regards, Andrew
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!