Generated JavaDoc to code insight?
1 posts in topic
Flat View  Flat View

Posted By:   Anonymous
Posted On:   Wednesday, February 27, 2002 10:21 AM

I'm trying out the IDEA 2.5.1 on linux, and found the JavaDoc API path under project properties. I added some paths, but couldn't get any documentation using the "Quick JavaDoc". Anyway, it displays documentation for source files, but ignores html API docs.

Re: Generated JavaDoc to code insight?

Posted By:   Serge_Baranov  
Posted On:   Wednesday, March 6, 2002 07:48 AM

It seems that you are mixing the Ctrl—Q and Shift—F1 functionality, while the difference is as follows:

1. The Shift—F1 key combination opens the browser with the JavaDoc for
the item at which the caret is currently positioned (you even don't need to highlight it). Any generated JavaDocs can be available with this
feature, by adding their paths to the "JavaDoc API Paths" tab of the
"Project Properties | Paths" dialog.

2. The Ctrl—Q key combination opens the IDEA window with the JavaDoc
comments that are generated in runtime directly from the sources available within your project. This means that is you have the JDK sources added to your sourcepath, their JavaDoc comments will also be available with the Ctrl—Q combination. Any class, method or field created by you and supplied with the JavaDoc comments (no matter whether
you have compiled the source code or not) will be immediately available
with this feature.
About | Sitemap | Contact