This week's book giveaway is in the OCAJP forum.
We're giving away four copies of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) and have Khalid A Mughal & Rolf W Rasmussen on-line!
See this thread for details.
Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

generate the java Doc

 
omar bili
Ranch Hand
Posts: 177
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi, is there a special tool needed to
generate my classes docs, if there is
where i can download it and please i need
a tutorial to learn how to generate the docs
Thanks
 
Paul Sturrock
Bartender
Posts: 10336
Eclipse IDE Hibernate Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes there is - its called Javadoc and its included in the bin directory of your JDK. Assuming your PATH is set up correctly, type "javadoc -help" from the command line and that should get you started.
 
Fisher Daniel
Ranch Hand
Posts: 582
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
I ussually build my classes's Javadoc using Apache Ant build.

Hope this helps and correct me if I am wrong

thanks
daniel
 
omar bili
Ranch Hand
Posts: 177
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi guys and thanks for the help
i am trying now the javadoc coz
i think it is less complicated
Omar
 
omar bili
Ranch Hand
Posts: 177
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
i am locked:
my class is Car.java
public class Car {
/** name of the car */
String name ;
String model;
int price ;
/*
the constructor. to construct
*/
public Car() {
}

/**
function that return the Name as a String.to a String
*/
String getName() {
return name;
}
/**
function that return the Name as a int.
@param void
*/
int getPrice() {
return price;
}
}


when i tried to generate the javadoc
the javadoc didn't include the attributes
and the function, what is missing ??
Thanks
 
Jeroen Wenting
Ranch Hand
Posts: 5093
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
By default javadoc includes only public elements of a class. You need to set some compiler options to get more restricted elements to show up as well.
 
Hung Yee
Greenhorn
Posts: 18
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Sun has a link about how to use the javadoc tool:
http://java.sun.com/j2se/javadoc/index.jsp
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic