Roumen's Weblog

Po	Út	St	Čt	Pá	So	Ne
« únor 2010
1	2	3	4	5	6	7
8	9	10	11	12	13	14
15	16	17	18	19	20	21
22	23	24	25	26	27	28


Today

Navigation

Speaker Profile
Roumen's Weblog
Login
Sun Bloggers
Technorati Profile

Am I popular?

Today's Page Hits: 495

Contacts

Name: Roman Strobl
E-mail: roman dot strobl
at sun dot com

NetBeans

Java Sites

Javalobby
The Server Side
Java Tips
Java Blogs
java.net
java.sun.com
java.cz

Blogs

License info

This work is licensed under a Creative Commons License.

Map of visits

« Make your IDE beep! | Main | Gmail is just cool »

Pátek duben 01, 2005

Generating Javadoc from JDK Sources

I've tried to build the JDK javadoc from sources according to Tor's suggestion. I've found the magical options somewhere on java.sun.com:

javadoc
-J-Xmx500M
-d docs
-use
-splitIndex
-windowtitle 'Java 2 Platform 5.0 API Specification'
-doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform 5.0 API Specification'
-header '<b>Java 2 Platform </b><br><font size="-1">5.0</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-2004 Sun Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All 
Rights Reserved.</font>' 
-group "Core Packages" "java.*" 
-overview /home/src/overview.html 
-sourcepath /home/src 
java.applet java.lang <include all of the package names>

You need to put on the last line all packages from which you want to build javadocs, wildcards didn't help here. It works! You get the JDK javadoc without having to download anything extra. The tradeoffs are the speed of building, it really takes time. And some of the javadocs are missing for classes which don't have sources (security, etc.).

So now it's a question what is better - to let users build there javadocs on request like this or to increase the boundle size and give them full documentation including specs? A good topic for discussion, I guess.

Comments:

Why not just download already generated javadoc along with the sdk from java.sun.com? You can even get the 6.0 docs, if you really want to =) http://www.java.net/download/jdk-6_0-ea-bin-b30-apidocs-31_mar_2005.jar Dmitri Java2D Team

Posted by Dmitri Trembovetski! on duben 02, 2005 at 10:08 dop. CEST #

Dmitri, as Tor wrote in his blog we are solving how to get JDK javadoc with the IDE (me with NetBeans, him with Creater). So that users don't have to download anything extra and get it right with the IDE. That improves the out of box experience as they don't have to search for anything and have JDK javadocs integrated right with the IDE. So the options are:

1. Increase boundle size - IDE+JDK+documentation
2. Keep boundle size - IDE+JDK+generate javadoc

So currently if they want JDK javadoc they download it from java.sun.com as you suggest. Our goal is to make this simplier for them - to have no extra downloads.

Posted by 62.245.74.133 on duben 02, 2005 at 10:34 dop. CEST #