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.

Bug 179396 - Document how to make the "show javadoc" command work consistently.
Summary: Document how to make the "show javadoc" command work consistently.
Status: RESOLVED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Java (show other bugs)
Version: -S1S-
Hardware: PC Linux
: P3 normal with 1 vote (vote)
Assignee: AlyonaStashkova
URL:
Keywords:
Depends on: 160485
Blocks:
  Show dependency tree
 
Reported: 2010-01-11 12:27 UTC by fishtoprecords
Modified: 2011-07-20 10:14 UTC (History)
3 users (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description fishtoprecords 2010-01-11 12:27:23 UTC
Please, please, document how to make the "show javadoc" command work consistently. 

I've been using NB for years and every update breaks the "show javadoc" links. I stumble through trying everything I can guess, and make it work, just in time
for the next release to break it.

Please document the right way to make this work.

Assume I have downloaded all the proper documentation jar files.

Do I point NB to the jar itself? or
do I need to unjar the file into individual files?
Do I point to the directory that contains the jar? or to the jar itself?
If I unjar them, do I point to the directory? or to the index.html file
directly?

There are probably a half dozen other combinations, and I keep trying
each of them every release. Please. I'll accept that its manual, but it
should not be random after you download the javadoc jars


I really don't care how many hoops I have to jump through, just that when I do them, it works. If I need  to unjar the html pages, fine.
Comment 1 Jan Becicka 2010-10-11 13:09:01 UTC
Just for sure. "Adding Javadoc to a Project" section in Help (F1) is not good enough?
Comment 2 fishtoprecords 2010-10-11 13:23:27 UTC
I was completely unaware of the existence of "Adding Javadoc to a Project" section in Help (F1). I'll look at it.

However, it does not address the specific questions that I included in the initial bug submission ten months ago.

When it works, this is a great feature. But I can not find a reliable way to do it, and I seem to need to do it every time Netbeans is updated.
Comment 3 Jan Becicka 2010-10-21 08:12:06 UTC
javadoc roots are defined in java/project.
Comment 4 Tomas Zezula 2010-10-21 08:59:15 UTC
There are two ways:
1st) You can define a library in the Toools/Library Manager and attach the library javadoc to it un the Javadoc tab. The Javadoc tab should verify the validity of the file (it looks up index and package-list). If it's not found it complains about it.
2nd) You don't need to create a library. You can just add a jar file on the Project's classpath and in the Project's customizer (Libraries) you press "Edit" and points to the javadoc you downloaded.

In general both jar (zip) and folders are accepted by the IDE. Other types (tgz, rar) are not accepted. But the folder or archive has to contain the index and package-list.

The description is available in the Help/Help Contents, search for Adding Javadoc to a Project.
Comment 5 Irina Filippova 2010-10-22 05:42:32 UTC
Reopening and reassigning to myself, component usersguide
Comment 6 Irina Filippova 2010-12-29 07:22:30 UTC
Reassigning to Ken.
Comment 7 Kenneth Ganfield 2011-01-20 13:51:54 UTC
reassigning to alyona
Comment 8 Jesse Glick 2011-01-28 13:46:00 UTC
A fix of bug #160485 would probably reduce the need for documentation.
Comment 9 AlyonaStashkova 2011-02-02 08:50:03 UTC
Required info documented in the Javadoc FAQ at http://wiki.netbeans.org/FaqJavaDoc
Comment 10 emrecio 2011-07-20 02:28:28 UTC
But that javadoc faq doesn't say anything about netbeans platform's wrapped libraries. The only javadoc selectable tab is in the "Tools -> Netbeans Platform" but even then my wrapped /usr/share/java/log4j.jar doesn't correctly show the javadoc in /usr/share/javadoc/log4j. 

Note, however, that a regular project (i.e.: console application, etc.) can use the Global Library Manager's library and javadoc's just fine that I added. So... how do I add javadocs to a wrapped netbeans platform library.
Comment 11 Jesse Glick 2011-07-20 10:14:55 UTC
(In reply to comment #10)
> that javadoc faq doesn't say anything about netbeans platform's wrapped
> libraries.

http://wiki.netbeans.org/FaqJavaDoc#Ad-Hoc