aspose file tools*
The moose likes Beginning Java and the fly likes How to get the complete API documentaton using java-doc Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "How to get the complete API documentaton using java-doc" Watch "How to get the complete API documentaton using java-doc" New topic
Author

How to get the complete API documentaton using java-doc

Sarath Mohan
Ranch Hand

Joined: Mar 17, 2001
Posts: 213
Dear friends,
I created a lot of java source which resides in different sub packages.
e.g root - no java files
pack1 -- some java files
subpack2 --- some java files

What is java doc command to get the complete html documentation for all java source files in all subpackages exactly like we have in jdk API documentattion.
Please give me the javadoc utility command
Thanks
Binu


Sarath Mohan
Cindy Glass
"The Hood"
Sheriff

Joined: Sep 29, 2000
Posts: 8521
JavaDoc Instructions
First you put javadoc comments in all your source files.
Then you run your source files through the JavaDoc tool - ususally using a .bat or .sh file to list the commands and parameters.
This is an example of a .bat file for windows

REM Sample Javadoc batch file for Windows
javadoc ^
-J-Xmx100M ^
-d docs ^
-use ^
-splitindex ^
-windowtitle "Java 2 Platform v1.3 API Specification" ^
-doctitle "Java<sup><font size="-2">TM</font></sup> 2 Platform v1.3 API Specification" ^
-header "<b>Java 2 Platform </b><br><font size="-1">v1.3</font>" ^
-bottom "<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">Submit a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>" ^
-group "Core Packages" "java.*" ^
-overview i:\java\pubs\ws\1.3\src\share\classes\overview.html ^
-sourcepath i:\java\pubs\ws\1.3\src\share\classes ^
java.applet java.lang


"JavaRanch, where the deer and the Certified play" - David O'Meara
Sarath Mohan
Ranch Hand

Joined: Mar 17, 2001
Posts: 213
Thanks
But it didn't work.

I want a single command recursively document all my java files resides in different subpackages which shares a common root package. Do I need to specify each package seperately?
I have gone thru the entire documentaion at Sun Site. But I am still
Please could any one help me in this regard?
Thanks
Binu
Cindy Glass
"The Hood"
Sheriff

Joined: Sep 29, 2000
Posts: 8521
It is all described in the doco.

Case 1 - Run recursively starting from one or more packages - This example uses -sourcepath so javadoc can be run from any directory. It traverses the subpackages of java excluding packages rooted at java.net and java.lang. Notice this excludes java.lang.ref, a subpackage of java.lang).
% javadoc -d /home/html -sourcepath /home/src -subpackages java -exclude java.net:java.lang

If it didn't work then either you are commenting the code incorrectly, or you are calling the command incorrectly.
 
jQuery in Action, 2nd edition
 
subject: How to get the complete API documentaton using java-doc