Not exactly sure what a Javadoc is, but I think I need one...

Started by Lethal_Vitamin, November 29, 2013, 19:19:54

Previous topic - Next topic

Lethal_Vitamin

~~FIRST POST - BEGINNING OF EPIC JAVA LEARNING ADVENTURE~~

Uh, hi, complete LWJGL noob here. I'm getting this error, Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found., when I mouse over one of the things that starts with "gl". I was following this guy's, http://www.java-gaming.org/topics/lwjgl-tutorial-series-contents/30681/view.html tutorial, but he uses a lot of confusing words and it's hard to understand his code that I copied and pasted into Eclipse because the words don't tell me what they mean when I mouse over them like they usually do.

quew8

So check out this link on the wiki, maybe you already have http://www.lwjgl.org/wiki/index.php?title=Setting_Up_LWJGL_with_Eclipse. Now I notice it doesn't actually say how to attach the javadoc, but it's a pretty simple process.

-Firstly make sure you have downloaded the LWJGL javadoc (and source as well if you so wish), the links for this is (these are) right next to the actual library download.

-Now when it tells you to link to the native files. You'll notice there is also a "javadoc location" and "source attachment." Simply set these up to point to the downloaded javadoc/source.

Also I feel that, since this is your first attempt, I must ask you not to try and make a first person shooter but to start off with something simple. Like Pong, Tetris or Space Invaders. It doesn't seem as impressive but you'll actually finish it and learn more. I only say this because too many people try to start off with far too complex games.

Lethal_Vitamin

The OpenGL functions don't give the error, Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found., anymore, it's just blank. I checked the class GL11 in the javadoc and saw that none of its functions have descriptions. Any idea where I might find them?

Cornix

I dont think the lwjgl-classes actually have any kind of real documentation.
Most of their methods are just 1-to-1 implementations of the openGL functions, or they are wrappers to make the use slightly easier.

If you want to read a documentation I would suggest readingthe openGL reference pages:
http://www.opengl.org/sdk/docs/man/

You can find anything you need right there.

quew8

Until LWJGL 3.0 when all of the LWJGL wrapper functions will have the OpenGL documentation in their JavaDoc. But until that monumental day...