• 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

Javadoc and nested classes?

 
Ranch Hand
Posts: 172
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
How can I get javadoc to include documentation for nested classes? I want to have a nested class documented, even though its implementation is not available.

In other words:

class A{
public B _b;
...

class B
{
...
}
}

Since _b is a public member of B there's good reason to document the B interface in javadoc. You see?

Thanks!

Rob
 
Ranch Hand
Posts: 1258
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I've never noticed what javadoc spits out for nested classes ... but the documentation indicates that it supports nested classes. I imagine that you're not specifying that it should document all members, including the "default" visibility ones (your nested class). I'd check out the tools documentation and see if you need to specify some additional parameters and see how it goes.
 
Ranch Hand
Posts: 341
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
My idia is declare another interface which is inner class B implements,the _b variable refer to that interface like this:



You can document this interface C instead of the inner class B.
[ July 02, 2004: Message edited by: Surasak Leenapongpanit ]
 
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
reply
    Bookmark Topic Watch Topic
  • New Topic