• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Explain Javadoc Usuage!

 
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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

VikasSood
 
Ranch Hand
Posts: 194
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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.
 
Vikas Sood
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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
 
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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
 
Vikas Sood
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Andrew,
So that means I will have to document all the inner classes and annonymous classes i have used, and would be ok if i run javadoc without the -private option.
kindly comment
VikasSood
 
Andrew Monkhouse
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Vikas,
I did not have any inner classes in my app, and for annonymous clases I just used C++ style comments (I ignored what it could do to javadoc):

Regards, Andrew
[ June 09, 2003: Message edited by: Andrew Monkhouse ]
 
reply
    Bookmark Topic Watch Topic
  • New Topic