How can I add the JOGL JavaDoc to Eclipse?

OpenGL Development JOGL Development
#1

Hello,

is it possible to add the JOGL javadocs to my favourite IDE Eclipse 3
or IDEA 4.5 so that I can see the javadoc for every class/method/attribute
in my IDE while I am typing?

Greetings Janni

#2

Hi,

If I remember well, you just have to add the .zip file to the Javadoc entry of the jogl lib you add in the classpath from project properties… It works fine, but sometines it’s quite long since GL class contains a lot of methods.

#3

[quote]Hi,

If I remember well, you just have to add the .zip file to the Javadoc entry of the jogl lib you add in the classpath from project properties… It works fine, but sometines it’s quite long since GL class contains a lot of methods.
[/quote]
Hello, sorry, I did not understand you,
could you explain a bit more detailed what I have to do? :frowning:

The file containig the javadocs for jogl is called
javadoc_public.zip, what do I do with it?

Greetings Janni

#4

So, with Eclipse in front of me i’ll try to be clearer :

Menu Project->Properties / Java Build Path Item.
You should have a jogl.jar lib somewhere in the libraries tabl.
Expanding the node you’ll see a hole to put the zip file in.

Hope it was clearer.

By the way : this is not a JOGL question but a general Eclipse question no :wink:

#5

[quote]So, with Eclipse in front of me i’ll try to be clearer :

Menu Project->Properties / Java Build Path Item.
You should have a jogl.jar lib somewhere in the libraries tabl.
Expanding the node you’ll see a hole to put the zip file in.
[/quote]
Hello,

thanks for your answer, I did not know if the JOGL Javadoc was built correctly.
I have done everything as you said, but I still get no
info about the JOGL items.

Type in your project:

       GLCapabilities glCaps = new GLCapabilities();
       glCaps.setRedBits( 8 );

and you will see that Eclipse is not showing any infos on setRedBits, although the JavaDoc for JOGL (viewed in a browser) says:

“Sets the number of bits requested for the color buffer’s red component.”

So what is going on here? Is this an eclipse bug or in the JOGL-Javadoc?

#6

Well,

I tried it, and indeed it doesn’t work…
That may be the reason why i let eclipse outside of my home computer and use it only at work.

It’s strange, since Javadoc works fine for others libs…
I can’t figure out what is wrong. You should try with different version of jogl to see if the problem is not in the zip file.

#7

[quote]I tried it, and indeed it doesn’t work…
That may be the reason why i let eclipse outside of my home computer and use it only at work.

It’s strange, since Javadoc works fine for others libs…
I can’t figure out what is wrong. You should try with different version of jogl to see if the problem is not in the zip file.
[/quote]
Hi,

I just tried with Intellij IDEA 4.5 with the same results,
it does not show any Javadoc comments.

So the JOGL Javadoc file seems to be incorrect.

Who must I contact to get this fixed?

Janni

#8

Well i’m not so sure that the zip file is incorrect since it works fine with netbeans… That’s strange. I didn’t, and won’t, have much time to test it more at work on Eclipse but we should be able to get it work, don’t we?

#9

Eclipse does not read these informations from the javadoc html files but from the javadoc comments in the source files.

  1. Download the jogl source.
  2. Compile the source to create the autogenerated java files GL.java and GLU.java.
  3. Select the source folder as source attachment for jogl.jar in Eclipse.
#10

or you just download the precompiled binaries + the source.zip.

and attach the zip to the jar

#11

The source zip does not contain all java files before it is compiled.