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: | Document how to make the "show javadoc" command work consistently. | ||
---|---|---|---|
Product: | usersguide | Reporter: | fishtoprecords <fishtoprecords> |
Component: | Java | Assignee: | AlyonaStashkova |
Status: | RESOLVED FIXED | ||
Severity: | normal | CC: | jbecicka, jglick, kganfield |
Priority: | P3 | ||
Version: | -S1S- | ||
Hardware: | PC | ||
OS: | Linux | ||
Issue Type: | ENHANCEMENT | Exception Reporter: | |
Bug Depends on: | 160485 | ||
Bug Blocks: |
Description
fishtoprecords
2010-01-11 12:27:23 UTC
Just for sure. "Adding Javadoc to a Project" section in Help (F1) is not good enough? 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. javadoc roots are defined in java/project. 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. Reopening and reassigning to myself, component usersguide Reassigning to Ken. reassigning to alyona A fix of bug #160485 would probably reduce the need for documentation. Required info documented in the Javadoc FAQ at http://wiki.netbeans.org/FaqJavaDoc 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. (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 |