File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Beginning Java and the fly likes Hoiw to document member variables of a class? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Hoiw to document member variables of a class?" Watch "Hoiw to document member variables of a class?" New topic
Author

Hoiw to document member variables of a class?

qionghua yang
Ranch Hand

Joined: Oct 31, 2000
Posts: 68
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
Junilu Lacar
Bartender

Joined: Feb 26, 2001
Posts: 5288
    
  10

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).]


Junilu - [How to Ask Questions] [How to Answer Questions]
qionghua yang
Ranch Hand

Joined: Oct 31, 2000
Posts: 68
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
Bartender

Joined: Feb 26, 2001
Posts: 5288
    
  10

OK, my bad. -private option will do what you want.
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: Hoiw to document member variables of a class?