External Javadocs - how?

Let me jump in for a related question to "Re: Java Doc Auto Popup - how?".


(using #813).

(This one seems rediculously dumb...almost scared to ask...but here goes)

How the heck do you get View External Javadoc to work? This area just
SCREAMS out for usability enhancements. I am not talking about Quick
Javadoc - only the regular HTML Javadocs for a given SDK.

1. I downloaded the documentation for 1.4.1 and extracted it to sit under
the C:\j2sdk1.4.1_01 directory (ie. C:\j2sdk1.4.1_01\docs).

2. I added C:\j2sdk1.4.1_01\docs to the Javadoc paths under Project
Properties


Problem #1:
I press Shift-F1 and/or choose View External Javadocs and I meet my first
hurdle: "Please select the element for which you wish to view the
documentation". I would expect the index.html page for the JavaDocs to come
up and let me browse around from there.

Problem #2:
I select an element (ie. println) and press Shift-F1 and/or choose View
External Javadocs and it repeats the message "Please select the element for
which you wish to view the documentation". It seems to me like println is a
valid "element", though I cant understand exactly what "element" means in
this context or what IDEA is asking for. println is certainly in the
JavaDocs.

From a usability perspective, I chose println because it was nearby and I
just want to get to the Javadocs and then start looking for what I am
really looking for: I am looking to do some string manipulation and I dont
know yet which method will server me best in my little exercise; I think
charAt and/or substring might do but I am not sure. This whole notion of
selecting an element first to go look it up is flawed since it presumes you
already know what you are looking for and want the details of the
method/class and doesn't facilitate browsing. What if I want to do some
unfamiliar reflection stuff but dont know any of the classes or method
names? But...I'd even settle for this println hack at this point. Yet,
under no circumstances do the External Javadocs come up.

I feel like I am missing something small or I didn't configure it properly,
but that goes back to my first observation: this is incredibly confusing
and/or doesn't work as intended. After completing steps 1 and 2 noted
above, what else is necessary?

Right now, I have to navigate to the docs directory using windows explorer
and fire up the index.html myself. This is very crude. Contrary to the
rest of this phenomenal IDE, this is so not IntelliJent.

:)

TIA.

Michael.


"Trevor" <trevor.samaroo@gs.com> wrote in message
news:17019782.1051899287096.JavaMail.jrun@is.intellij.net...

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



5 comments

I knew it was something "small". The path to specify for Javadocs under
Project Properties should be C:\j2sdk1.4.1_01\docs\api, and not
C:\j2sdk1.4.1_01\docs.

While I am here commenting on External Javadocs, I thought it would be
useful to be able to right-click and Go To External Javadoc in addition to
Declaration, Implementation, Type Declaration and Super Method. Not a big
deal, but it would be nice.

In any event, I'm posting this so it sits in the newsgroup for others to
search on because I know this mistake is too easy to make. Maybe this will
save some soul a little frustration.



"Michael Morett" <michaelmorett@yahoo.com> wrote in message
news:b9287i$lus$1@is.intellij.net...

Let me jump in for a related question to "Re: Java Doc Auto Popup - how?".

>
>

(using #813).

>

(This one seems rediculously dumb...almost scared to ask...but here

goes)
>

How the heck do you get View External Javadoc to work? This area just
SCREAMS out for usability enhancements. I am not talking about Quick
Javadoc - only the regular HTML Javadocs for a given SDK.

>

1. I downloaded the documentation for 1.4.1 and extracted it to sit under
the C:\j2sdk1.4.1_01 directory (ie. C:\j2sdk1.4.1_01\docs).

>

2. I added C:\j2sdk1.4.1_01\docs to the Javadoc paths under Project
Properties

>
>

Problem #1:
I press Shift-F1 and/or choose View External Javadocs and I meet my first
hurdle: "Please select the element for which you wish to view the
documentation". I would expect the index.html page for the JavaDocs to

come

up and let me browse around from there.

>

Problem #2:
I select an element (ie. println) and press Shift-F1 and/or choose View
External Javadocs and it repeats the message "Please select the element

for

which you wish to view the documentation". It seems to me like println is

a

valid "element", though I cant understand exactly what "element" means in
this context or what IDEA is asking for. println is certainly in the
JavaDocs.

>

From a usability perspective, I chose println because it was nearby and I
just want to get to the Javadocs and then start looking for what I am
really looking for: I am looking to do some string manipulation and I

dont

know yet which method will server me best in my little exercise; I think
charAt and/or substring might do but I am not sure. This whole notion of
selecting an element first to go look it up is flawed since it presumes

you

already know what you are looking for and want the details of the
method/class and doesn't facilitate browsing. What if I want to do some
unfamiliar reflection stuff but dont know any of the classes or method
names? But...I'd even settle for this println hack at this point. Yet,
under no circumstances do the External Javadocs come up.

>

I feel like I am missing something small or I didn't configure it

properly,

but that goes back to my first observation: this is incredibly confusing
and/or doesn't work as intended. After completing steps 1 and 2 noted
above, what else is necessary?

>

Right now, I have to navigate to the docs directory using windows explorer
and fire up the index.html myself. This is very crude. Contrary to the
rest of this phenomenal IDE, this is so not IntelliJent.

>

:)

>

TIA.

>

Michael.

>
>

"Trevor" <trevor.samaroo@gs.com> wrote in message
news:17019782.1051899287096.JavaMail.jrun@is.intellij.net...

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

>
>


0

While I am here commenting on External Javadocs, I thought it would be
useful to be able to right-click and Go To External Javadoc in addition to
Declaration, Implementation, Type Declaration and Super Method. Not a big
deal, but it would be nice.


I agree, although for consistency it should be under a View right-menu
option instead, since it's on the view menu at the top. Conversely, it
could move from the View menu to the Go To menu and also onto the
right-click menu. I have to say that I hardly use the right-click menu,
though. (:

Peter

0

Michael Morett wrote:

Problem #1:
I press Shift-F1 and/or choose View External Javadocs and I meet my first
hurdle: "Please select the element for which you wish to view the
documentation". I would expect the index.html page for the JavaDocs to come
up and let me browse around from there.


I agree somewhat with this. Often I find myself wanting to read the
Javadoc for a class that I'm considering using but I don't want to have
to type it's name into my source code just so that I can use Shift-F1 to
look it up. What I would like as a standard feature in IDEA is one of
the user-written Javadoc plugins which when invoked by Alt-J (for
example) pops up a dialog very much like the Ctrl-N Go to Class dialog
that allows me to choose a class and have it's Javadoc displayed via an
external browser.

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

Add ya votes! ;) http://www.intellij.net/tracker/idea/viewSCR?publicId=4352

Gordon Tyler wrote:

Michael Morett wrote:

>> Problem #1:
>> I press Shift-F1 and/or choose View External Javadocs and I meet my
>> first hurdle: "Please select the element for which you wish to view
>> the documentation". I would expect the index.html page for the
>> JavaDocs to come up and let me browse around from there.
>

I agree somewhat with this. Often I find myself wanting to read the
Javadoc for a class that I'm considering using but I don't want to
have
to type it's name into my source code just so that I can use Shift-F1
to
look it up. What I would like as a standard feature in IDEA is one of
the user-written Javadoc plugins which when invoked by Alt-J (for
example) pops up a dialog very much like the Ctrl-N Go to Class dialog
that allows me to choose a class and have it's Javadoc displayed via
an external browser.

>

Ciao,
Gordon



0

Nathan Brown wrote:

Add ya votes! ;) http://www.intellij.net/tracker/idea/viewSCR?publicId=4352


Hey, I've already voted for this! Silly me ;)

At least perhaps other people are now aware of it and will vote for it too.

Thanks,
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

Please sign in to leave a comment.