• 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

Hoiw to document member variables of a class?

 
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi there,
I have two classes (First and Second) inside one java file. I could not get the documents for the second class when I used the javadoc command. I am wondering if I need to do some specifial work for this class. Also, I can't get any documents for my member variables.
My code looks like this:
/**
* First class document
*/
public class First{
/**
* memeber variable document
*/
private String s;

.........
}
/**
* Second class document
*/
class Second {
..............
}
Thanks!
qionghua
 
Sheriff
Posts: 17644
300
Mac Android IntelliJ IDE Eclipse IDE Spring Debian Java Ubuntu Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I think JavaDoc ignores private members. Think about it: JavaDoc is a tool used to generate API documentation. Private members are not part of the API.

[This message has been edited by JUNILU LACAR (edited June 06, 2001).]
 
qionghua yang
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
How about the second class? Does the javadoc ignore it?
Actually I think I use
javadoc.exe -private
to get all the private members and class document.
Thanks!
qionghua
 
Junilu Lacar
Sheriff
Posts: 17644
300
Mac Android IntelliJ IDE Eclipse IDE Spring Debian Java Ubuntu Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
OK, my bad. -private option will do what you want.
 
reply
    Bookmark Topic Watch Topic
  • New Topic