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 138543 - Netbeans API Documentation via Help menu
Summary: Netbeans API Documentation via Help menu
Status: RESOLVED FIXED
Alias: None
Product: apisupport
Classification: Unclassified
Component: Project (show other bugs)
Version: 6.x
Hardware: All All
: P3 blocker (vote)
Assignee: rmichalsky
URL:
Keywords:
Depends on: 148745
Blocks:
  Show dependency tree
 
Reported: 2008-06-28 04:43 UTC by daveyost
Modified: 2008-10-01 05:56 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description daveyost 2008-06-28 04:43:52 UTC
http://wiki.netbeans.org/DevFaqGeneralWhereIsJavadoc
says

"go to the update center (Tools > Plugin Manager) in the NetBeans IDE and request the NetBeans API Documentation module, which bundles Javadoc 
matching your IDE release."

I did that.  Now I can ask the editor to show me javadoc for library stuff.  Good.  But the page goes on to say

"Use Help > Javadoc References to see the overview pages for API sets currently used by your open projects."

When I do that, I do not see the Netbeans API Documentation in the submenu.
Comment 1 Tomas Danek 2008-08-21 12:13:18 UTC
Seems to be bug in module NetBeans API Documentation, please reassign to module owner for evaluation. Thanks.
Comment 2 Jiri Kovalsky 2008-08-21 12:21:52 UTC
Can somebody from 'apisupport' gurus take a look at this? Thanks!
Comment 3 daveyost 2008-08-21 20:16:27 UTC
The web page needs to say what to do once you've downloaded the javadoc.zip file.

Also, the page should be clearly split up into three major bullets

There are three alternatives:

* Veiw the javadoc online
* Download the javadoc zip file and tell NetBeans where it is.
    * Go to the nightly..
    * ...
* Install the API Documentation plugin.
    * Go to Tools > Plugins
    * ...


Comment 4 daveyost 2008-08-21 20:17:44 UTC
Would someone who knows the answers to these questions please edit that page now to answer the question of what to do with the downloaded javadoc.zip? 
It doesn't need to be unziipped, right?
Comment 5 Jesse Glick 2008-08-22 01:27:24 UTC
NetBeans Platform Manager should work fine with the Javadoc inside a ZIP.
Comment 6 Milos Kleint 2008-08-25 13:22:19 UTC
daveyost: I assume you have a project opened that is using some of the netbeans apis when viewing the javadoc references
items.

BTW the javadoc references submenu might just be badly updated on mac. That's a sort of prevailing issue on mac that it
doesn't like dynamic menu content. We use hacks to get around it, but still..I'll have to check when I'm on my mac..

Not sure what the resolution of the issue shall be.. is the documentation subcategory correct,  Geertjan?
Comment 7 Lukas Hasik 2008-09-26 14:22:52 UTC
the problem here is that the NB API javadoc isn't added to the Javadoc References. Therefore you cannot use it Javadoc
Index Search. I can reproduce on WinXP.
The javadoc is correctly shown for NB API in the editor's javadoc of code completion. 

I checked 6.1 and it behaves in the same way. However it is bug imo. The module should add the javadoc references to NB.
Comment 8 Jesse Glick 2008-09-26 15:59:39 UTC
Richard please evaluate. If you install the NB API Doc module, then Javadoc should be available for all modules with a
documented API which are part of the default NetBeans platform. When you do that, Javadoc should appear in editor code
completion; and all API modules which are used by open modules you develop should appear under Help > Javadoc References
as individual entries. (One restart of the IDE might be required after first installing the module under some
conditions, I am not sure.)

I just tried it on Ubuntu/JDK 6 on NB 6.5 beta and it is working fine for me; I cannot reproduce any issue. Ran IDE on
fresh userdir, installed doc module from AU, created Feed Reader sample app. Help > Javadoc Refs shows Actions API,
Datasystems API, etc. I configured my web browser to be Firefox. Then selecting Actions API showed

http://127.0.0.1:8082/resource/jar%3Afile%3A/tmp/testud02/docs/NetBeansAPIs.zip!/org-openide-actions/overview-summary.html

as expected. Help > Javadoc Index Search and typing "SystemAction" also showed me the right docs.

Reminder: if you are using a non-default NetBeans platform, you will need to set up Javadoc for that platform manually;
you can set it to be the same ZIP as for the default platform if that is in fact the correct version, but in general you
might need to download a historical snapshot of the Javadoc to match that platform.
Comment 9 rmichalsky 2008-09-29 14:13:04 UTC
Help > Javadoc References and Index Search don't work without IDE restart. Will take a quick look if it is an easy fix,
otherwise I'll turn "Requires restart" on.

A workaround is obviously to restart IDE manually after installing the module.
Comment 10 rmichalsky 2008-09-30 17:08:13 UTC
"Requires restart" turned on for module, see issue #148745 for additional info. core-main #cd33ec4f8693
Comment 11 Quality Engineering 2008-10-01 05:56:51 UTC
Integrated into 'main-golden', will be available in build *200810010201* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main/rev/cd33ec4f8693
User: Richard Michalsky <rmichalsky@netbeans.org>
Log: #138543: module needs restart so that Javadoc shows up in Index Search and References