Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Hoiw to document member variables of a class?

 
qionghua yang
Ranch Hand
Posts: 68
  • Mark post as helpful
  • send pies
  • 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
 
Junilu Lacar
Bartender
Pie
Posts: 7465
50
Android Eclipse IDE IntelliJ IDE Java Linux Mac Scala Spring Ubuntu
  • Mark post as helpful
  • send pies
  • 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
  • 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
Bartender
Pie
Posts: 7465
50
Android Eclipse IDE IntelliJ IDE Java Linux Mac Scala Spring Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
OK, my bad. -private option will do what you want.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic