Java Doc Auto Popup - how?

Hi all,

I'm a bit confused as to HOW you get javadoc to popup for libraries that you download. Lets say that i want to use Jakarta commons-lang.jar or struts.jar. how do i include their respective javadoc so that they autopopup?
When i create an Intellij Library and specify a URL to the javadoc or even a filepath to the javadoc i get nothing. it only works if i download the libraries' source and include that in my project - but thats ludicrous!

can anyone explain how i can get this done? further, if it does work fine for you, what URL do you put as the javadoc source? do you put http://...../api ? OR .../api/index.html? whats the format.

If adding the javadoc to teh library path does not add it to the autopopup, what is the purpose?

Thanks in advance!

-Trevor

6 comments

ooops. i'm using idea 3.0.4...

thanks.

0

Trevor wrote:

I'm a bit confused as to HOW you get javadoc to popup for libraries that you download. Lets say that i want to use Jakarta commons-lang.jar or struts.jar. how do i include their respective javadoc so that they autopopup?


IDEA 3.0.x does not support QuickJavadoc (Ctrl-Q) for libraries which do
not include source. You can however open the Javadoc for a symbol in an
external browser using View->External Javadoc (Shift-F1).

There is a request open in the Tracker to make QuickJavadoc use external
Javadoc: http://www.intellij.net/tracker/idea/viewSCR?publicId=3584

Ciao,
Gordon

--
Gordon Tyler (Software Developer)
Quest Software <http://java.quest.com/>
260 King Street East, Toronto, Ontario M5A 4L5, Canada
Voice: 416-643-4846 | Fax: 416-594-1919

0

... it only works if i download the libraries' source and include that in

my project - but thats ludicrous!

Not that much. While you are developing, analyzing the source and showing
the actual javadocs (without having to regenerate them) is very useful.

I agree it would be better if quick javadoc could show library docs when the
source isn't available, but this implies analyzing html files and it may be
a tad complicated.

If adding the javadoc to teh library path does not add it to the

autopopup, what is the purpose?

Shift-f1 opens the javadoc in the external browser. Not as useful as the
quick javadoc but usable.


0

As far as I understand the mechanism the Quick-Popup uses JavaDoc parsed from sources. Makes it somehow arkward to use, but I'm afraid parsing JavaDoc html into small parts is a hard thing.

JavaDoc path should be useful for Shift-F1.

0

There is a request open in the Tracker to make QuickJavadoc use external
Javadoc: http://www.intellij.net/tracker/idea/viewSCR?publicId=3584


Exactly. And we plan to implement it in Aurora.

--
Valentin Kipiatkov
JetBrains, Inc
http://www.intellij.com
"Develop with pleasure!"


"Gordon Tyler" <gordon.tyler@sitraka.com> wrote in message
news:b8uedv$10s$1@is.intellij.net...

Trevor wrote:

I'm a bit confused as to HOW you get javadoc to popup for libraries that

you download. Lets say that i want to use Jakarta commons-lang.jar or
struts.jar. how do i include their respective javadoc so that they
autopopup?
>

IDEA 3.0.x does not support QuickJavadoc (Ctrl-Q) for libraries which do
not include source. You can however open the Javadoc for a symbol in an
external browser using View->External Javadoc (Shift-F1).

>

There is a request open in the Tracker to make QuickJavadoc use external
Javadoc: http://www.intellij.net/tracker/idea/viewSCR?publicId=3584

>

Ciao,
Gordon

>

--
Gordon Tyler (Software Developer)
Quest Software <http://java.quest.com/>
260 King Street East, Toronto, Ontario M5A 4L5, Canada
Voice: 416-643-4846 | Fax: 416-594-1919

>


0

A "first-glance" version of Ctrl-Q for external JavaDocs will be available as soon as the next build be succesfully built.

Parsing Standard DocLets turned out to be very simple since javadoc inserts meaningful comments there. Support of other DocLets have to be considered separatedly.

Be(a)st regards,
Dmitri.

0

Please sign in to leave a comment.