This week's book giveaway is in the OCAJP 8 forum. We're giving away four copies of OCA Java SE 8 Programmer I Study Guide and have Edward Finegan & Robert Liguori on-line! See this thread for details.
Hi friends, As required by the specs i am using javadoc to create documentaion comments. I am using the following command line: javadoc -private suncertify.db suncertify.client suncertify.server Everything runs fine and javadoc files are created without any error of any type.But the problem lyes in the fact that apart from including all private comments, the use of -private option causes generation of javadoc files for all inner classes as well.As i have not documented these classes, they come out rather plain.the question is should i document them as well as i am already documenting all the private members, or can you suggest a way of them not getting created. Kindly comment
Hi Vikas, Why are you using private option to generate javadoc? Is it must to generate documentation for all scopes (public, protected, package, private)? I am thinking to provide documentation only on all public mentods, and protected methods if any but not on private, and package visibility. Even Java API provides only public and protected scopes only. Regards, Ganapathy.
Joined: Sep 03, 2002
Hi Ganapathy, I have gone through this forum regarding the use of private option for generating javadoc documentation, and found many people doing it, including Mark,and also it helps a user of documentation get more information regarding the application by having access to documentation of all the members of the application.Irrespective of those members being private ,protected or public. Do you know of some way to prevent documentation of inner classes? VikasSood
Hi Vikas I documented all my private classes and variables as though they were to be documented using Javadoc, but for the submission I only used the standard javadoc (I did not specify the "-private"). I got 100% for documentation, so I believe that it is not necessary for you to use "-private". Regards, Andrew