jQuery in Action, 3rd edition
The moose likes Beginning Java and the fly likes javadoc for generating api's Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Make it so: Java DB Connections & Transactions this week in the JDBC forum!
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "javadoc for generating api Watch "javadoc for generating api New topic

javadoc for generating api's

Shyam Prasad Murarka
Ranch Hand

Joined: May 02, 2005
Posts: 209
Dear Readers,
I have a package called maths which has two more packages namely;
server and client.

Basically its like this : maths.server and maths.client

Inside both the packages I have many files. I want to generate their details with the help of the javadoc tool.

I did this:
I navigated inside the server folder and typed the following command : javadoc -classpath ./ ServerListener.java

ServerListener is my main file inside the server package. But the other files are not linked when the HTML files are generated. Only deatils of the ServerListener class is generated. The following lines are generated alongwith an error:

Loading source file ServerListener.java...
Constructing Javadoc information...
ServerListener.java:14: cannot find symbol
symbol : class ClientThread
location: package maths.server
import maths.server.ClientThread;

Standard Doclet version 1.5.0
Building tree for all the packages and classes...
Generating maths/server/\ServerListener.html...
Generating maths/server/\package-frame.html...
Generating maths/server/\package-summary.html...
Generating maths/server/\package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...
1 warning

With Best Regards,
Shyam Prasad Murarka
Carol Enderlin
Ranch Hand

Joined: Oct 10, 2000
Posts: 1364
Check out the documentation on javadoc at javadoc - The Java API Documentation Generator.

Try running javadoc command from the top level, in the directory that your maths package is in. Did you want to just create the javadoc for that one class?

javadoc maths/server/ServerListener.java -d javadocDir

or to generate for maths and subpackages

javadoc -subpackages maths -d javadocDir

I add the -d so the javadoc files go to a separate directory.
[ May 14, 2005: Message edited by: Carol Enderlin ]
Shyam Prasad Murarka
Ranch Hand

Joined: May 02, 2005
Posts: 209
Dear Carol,
Thank you very much. It worked.
Carol Enderlin
Ranch Hand

Joined: Oct 10, 2000
Posts: 1364

You're welcome!
I agree. Here's the link: http://aspose.com/file-tools
subject: javadoc for generating api's
It's not a secret anymore!