This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
Summary: | NetBeans does not show Javadocs for JDK classes | ||
---|---|---|---|
Product: | java | Reporter: | Inderjeet Singh <inder0> |
Component: | Platform | Assignee: | Tomas Zezula <tzezula> |
Status: | RESOLVED FIXED | ||
Severity: | blocker | CC: | anebuzelsky, issues, jchalupa, joshis, jpokorsky, rkubacki, robertmcauliffe, ttran |
Priority: | P2 | ||
Version: | 5.x | ||
Hardware: | All | ||
OS: | All | ||
Issue Type: | ENHANCEMENT | Exception Reporter: |
Description
Inderjeet Singh
2006-05-11 01:09:59 UTC
It looks like you did not add the javadoc to the java platform you are using See Tools->Java Platform Manager, chose right platform and open tab javadoc. Here you can add the javadoc for JDK classes (can by downloaded on http://java.sun.com/j2se/1.5.0/download.jsp as documentation). Closing as WorkForMe now, if the prevois step does not solve your problem, feel free to reopen. The big issue I have with the proposal solution is that it requires the user to add the javadocs. The Javadocs SHOULD BE INTEGRATED in the Netbeans 5.5. The user should NOT have to do this extra step. This is basic and quite important functionality, please reconsider to fix this by including javadocs in Netbeans. reassigning to javadoc This has nothing to do with the javadoc module. Anyway the Java Platform Manager adds the javadoc for newly added platforms automatically. The javadoc zip file has to be extracted into jdk/docs folder. In other cases you have to specify the javadoc location manually. The right fix for this bug is to bundle the JDK javadocs zip with Netbeans 5.5, and configure it to be used as Javadocs by default. All other solutions impose significant inconvenience to the user. This is significant user experience issue. I understand now. AFAIK JDK installation does not include documentation by default. This would be possible just in case of Netbeans + JDK bundle perhaps. Reassigning to the installer. I guess it is the right component. Just be aware that it is additional ~40 MB. For NetBeans IDE itself not possible as IDE can run on more than one JDK. IDE usually runs on 2 major JDK releases eg. NB 5.0 runs on JDK 1.4.2 and JDK 1.5.0. For NB+JDK bundle this is question for wider audience. I cannot decide we will bundle additional 40MB to installer. As we cannot guarantee that documentation will be installed (at expected place) this leads to a RFE to use javadoc from network as a fallback. It is not too difficult according to Tomas Zezula and we had this functionality in the past. > javadoc from network as a fallback
Given that the javadoc URLs on java.sun.com seem to be pretty stable over the
past years, we could hardcode a URL and point to it as the fallback.
Might be wise though, to contact jdk folks and make sure it is reasonable to do.
Not new in 5.5 and not going to address to 5.5. Will reconsider in next release. Any progress on this? Any decision? More than one year old issue. If this is going to be fixed anywhere please let us know so I can reassign this to proper subcomponent. looks like more RFE than a defect. *** Issue 22565 has been marked as a duplicate of this issue. *** Just an idea, another alternative solution could be as follows: When the user tries to view javadoc for a platform class, NetBeans could prompt the user somehow (a button in the box that says "no javadoc"?) to automatically download the docs. If the docs were automatically downloaded like this, then the issue of not knowing which version of the jdk the user is on wouldn't matter as much. Perhaps the source code could be downloaded in the same way (for source this would happen when the user tries to 'jump to class' or click through a method call or similar). Of course this still has the problem of needing to verify with Sun that the URLs are stable (and perhaps that they are algorithmically derivable from the version number?). *** Issue 153900 has been marked as a duplicate of this issue. *** If someone decides to download NB+JDK bundle, he/she is probably looking for an out-of-box solution for Java development. Therefore, I think additional download size (some 54MB) doesn't have to be an issue in this case. Also, average speed of download is higher than in 2006 when this issue was opened;)... To avoid confusion I`m reasigning this issue to java component and keep Issue 153900 for the following reason. Please reassing to the correct component (javadoc?) if necessary. Please treat this issue as the RFE for javadoc support in the IDE itself. Everything that is about automatic downloading docs and accessing them on the network as the fallback and such. In 2 worlds, that was described by Radim, Tonda and Robert in comments "rkubacki Mon Jul 10 08:22:22 +0000 2006", "anebuzelsky Mon Jul 10 12:46:50 +0000 2006" and "robertmcauliffe Tue Nov 25 09:49:29 +0000 2008" accordingly. The issue 153900 will be only about adding javadoc to NetBeans/JDK bundle (and, maybe, to NetBeans "JavaSE" bundle). Reassigning to the owner of the component. Please, use "Reassign issue to owner of selected subcomponent" when changing component next time. The NetBeans is now preconfigured with online JDK (JFX) javadoc. |