Eclipse Community Forums: Java Development Tools (JDT) » eclipse 3.5

Home » Language IDEs » Java Development Tools (JDT) » eclipse 3.5 - JavaDoc source and F2

eclipse 3.5 - JavaDoc source and F2 [message #504244]

Thu, 17 December 2009 15:20

Eclipse User

. I have attached a JavaDoc .zip file to a .jar.
I have also validated the path when doing so. It is OK.
. I can also view the documentation through a browser (outside of eclipse).

. But, when I am editing a class, and I enter a class name that I know is in the JavaDoc, I then click on the class name and hit the key "F2",
it tells me that there is no JavaDoc.

So, I wonder what is missing in my JavaDoc set of files. Besides the folders with the classes .htmls and etc., these are the files that the JavaDoc has at the root level:
allclasses-frame.html
allclasses-noframe.html
constant-values.html
deprecated-list.html
help-doc.html
index.html
javadoc.css
overview-frame.html
overview-summary.html
overview-tree.html
package-list

These are also the two folders created at the root level:
index-files
resources

Can somebody maybe see whether there is a file missing, or maybe there is a special way to generate the JavaDoc files to be able to use them in eclipse?

I would appreciate any help.

Re: eclipse 3.5 - JavaDoc source and F2 [message #504633 is a reply to message #504244]

Mon, 21 December 2009 15:45

Eclipse User

I have also tried the following which did not work either:
- putting the JavaDoc files in the root and rezipping it
- used a .jar format instead

Just as an added note, besides being able to open it in a browser (when I use the Validate option when setting the JavaDoc source), it does work in the IDEA IDE. So there is something that Eclipse expects besides the package-list and index.html which is causing the JavaDoc invocation to say that there is no JavaDoc set for the class.

Re: eclipse 3.5 - JavaDoc source and F2 [message #504653 is a reply to message #504633]

Mon, 21 December 2009 17:04

Eclipse User

Originally posted by: BlackularX.googlemail.com

Did you mean Shift+F2 in a java perspective?

gsb wrote:
> I have also tried the following which did not work either:
> - putting the JavaDoc files in the root and rezipping it
> - used a .jar format instead
>
> Just as an added note, besides being able to open it in a browser
> (when I use the Validate option when setting the JavaDoc source), it
> does work in the IDEA IDE. So there is something that Eclipse expects
> besides the package-list and index.html which is causing the JavaDoc
> invocation to say that there is no JavaDoc set for the class.

Re: eclipse 3.5 - JavaDoc source and F2 [message #504658 is a reply to message #504633]

Mon, 21 December 2009 13:06

Eclipse User

Originally posted by: BlackularX.googlemail.com

Have you tried adding your jar file as a referenced library in the
projects build path?

gsb wrote:
> I have also tried the following which did not work either:
> - putting the JavaDoc files in the root and rezipping it
> - used a .jar format instead
>
> Just as an added note, besides being able to open it in a browser
> (when I use the Validate option when setting the JavaDoc source), it
> does work in the IDEA IDE. So there is something that Eclipse expects
> besides the package-list and index.html which is causing the JavaDoc
> invocation to say that there is no JavaDoc set for the class.

Re: eclipse 3.5 - JavaDoc source and F2 [message #504661 is a reply to message #504658]

Mon, 21 December 2009 18:22

Eclipse User

Either Shift+F2 or F2 use the JavaDoc setup.

What do you mean by
>Have you tried adding your jar file as a referenced library in the
>projects build path?

There is already the .jar file containing the .class files. I am just
setting the JavaDoc for this .jar
but it does not work for my JavaDoc file set.

I can search for the classes and import them, but when I hoover over a class. it tells me that JavaDoc has not been set for that class.

So, what would Eclipse look for beyond the package-list and index.html?

It is funny that when I do Shift-F2 it tells me that nothing is set up, instead of an error. But when I go to the library .jar itself (Project Properties, Build Path) and I test the JavaDoc attached it can open it in a browser.

Re: eclipse 3.5 - JavaDoc source and F2 [message #504754 is a reply to message #504661]

Tue, 22 December 2009 03:20

Eclipse User

Originally posted by: BlackularX.googlemail.com

No worries stay calm.
Right click on your project, click on properties, navigate to the java
build path, click on the Libraries tab, add an external jar file. Onec
added expand the jar file entry and add the javadoc location here.

That is what I intended to say.

gsb wrote:
> Either Shift+F2 or F2 use the JavaDoc setup.
>
> What do you mean by
>> Have you tried adding your jar file as a referenced library in the
>> projects build path?
>
> There is already the .jar file containing the .class files. I am just
> setting the JavaDoc for this .jar but it does not work for my JavaDoc
> file set.
>
> I can search for the classes and import them, but when I hoover over a
> class. it tells me that JavaDoc has not been set for that class.
>
> So, what would Eclipse look for beyond the package-list and index.html?
>
> It is funny that when I do Shift-F2 it tells me that nothing is set
> up, instead of an error. But when I go to the library .jar itself
> (Project Properties, Build Path) and I test the JavaDoc attached it
> can open it in a browser.
>

Re: eclipse 3.5 - JavaDoc source and F2 [message #504800 is a reply to message #504754]

Tue, 22 December 2009 12:52

Eclipse User

somehow, I probably did not submit a message I tried posting yesterday.

I resolved this issue. It is a bug in Eclipse 3.5, JDT, I suppose.

The problem was that I originally set a JavaDoc pointing to the wrong path (by this I mean, within the JavaDoc file I needed to provide the root directory).
Both my library .jar and the JavaDoc file are external files
(not within the project directory tree).

Then I updated the JavaDoc setting, but apparently the update was not propagated.

I kept on checking the Project Properties Build Path and the .classpath file and any other Eclipse generated files within my project, and everything looked OK.
But I kept getting the same error, that I had not set up JavaDoc.

It was when I decided to change the external library to a project library, and set the JavaDoc again, that I noticed the problem. F2 kept on giving the same message but it mentioned the old directory for the old library. .classpath file and Project Properties showed ONLY the current library.

The problem was that in the Package Explorer pane, under Referenced Libraries, both the old and new libraries were showing, even though I had deleted the old. I tried Refreshing but still old lib was hanging in there. I then right-click on the old lib, and selected "Build Path | Remove from Build path" and the problem was gone.
F2 started working correctly.
So this might be an object kept in memory? and not updated.

Previous Topic:	Extract Simulink modal data to Conqat Library
Next Topic:	problem with birt viewer

Goto Forum:

-=] Back to Top [=-

Current Time: Tue Apr 15 02:00:51 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter