do the Plugins contain JavaDoc? It doesn't seem like that.
Is it possible to integrate it into Eclipse's help, so that it appears in Content, Index and Search?
Kind regards, Sebastian
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Yes you are right, I am intentionally not including javadoc and sources for java3d binaries. You can get both from java3d parent project site: https://java3d.dev.java.net/
To setup javadoc for java3d plugin, please see this page for instructions:
It is often useful to have sources available. For java3d API, download sources from java3d parent project and the setup is similar to attaching javadocs (except that you would specify sources in an archive). I will provide instructions on this soon.
For core.java3declipse.org, the easiest way is to import the project from SVN. The sources have JavaDoc comments, but I am not generating documentation (it should be straight forward if you import the project).
checking out was easy, but attaching the source is a little bit complicated.
The only way I'd expect to do that is the plugin dependencies section. But I cannot change anything ("The current classpath entry belongs to container 'Plug-in Dependencies' which does not allow user modification to source attachments entries.
Same with the Javadoc Location.
Any idea where I can setup the attachment?
Why don't you just deliver the plugin with docs?
Kind regards, Sebastian
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
I hope setting up javadoc for java3d API (for vecmath.jar, j3dcore.jar and j3dutils.jar) worked? You really need them.
For the rest of the plugins (core, geometry, etc...) there is not so much code yet so for now you can probably simply look at the source (there are comments there). I will be posting instructions on setting everything up soon. Meanwhile, you can use wiki pages and sources as the documentation. Check out the examples and tests as well, they can be of use as a reference.
To answer your question: There are no javadocs in the plug-ins from download section because they are ready to be redistributed with your applications. I will consider posting a development version of core,gemetry,etc... that would contain javadocs (but no promises). For java3d API though, it is unlikely that I will ever post version with java docs. For that you will have to follow the wiki instructions to attach javadocs.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi,
yes that helped.
But one thing what bothers me: When setting up documentation for Java3D, the whole plugin is copied into my workspace, consuming the disc space twice and making updates more difficult.
Look at http://www.informatik.fernuni-hagen.de/import/pi3/personen/pilgrim/gef3d/index.html
There's a Java3D plugin that already contains the docs (as a separate plugin). Maybe you can adopt this way?
Kind regards, Sebastian
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi,
do the Plugins contain JavaDoc? It doesn't seem like that.
Is it possible to integrate it into Eclipse's help, so that it appears in Content, Index and Search?
Kind regards, Sebastian
Hello Paul,
Yes you are right, I am intentionally not including javadoc and sources for java3d binaries. You can get both from java3d parent project site: https://java3d.dev.java.net/
To setup javadoc for java3d plugin, please see this page for instructions:
http://java3d-eclipse.wiki.sourceforge.net/DevelopmentEnvironment
I hope this helps.
Hi,
thanks for your answer.
What about the javadoc for org.java3declipse.core? Do I need the sources for that?
Kind regards, Sebastian
It is often useful to have sources available. For java3d API, download sources from java3d parent project and the setup is similar to attaching javadocs (except that you would specify sources in an archive). I will provide instructions on this soon.
For core.java3declipse.org, the easiest way is to import the project from SVN. The sources have JavaDoc comments, but I am not generating documentation (it should be straight forward if you import the project).
SVN url:
https://java3d-eclipse.svn.sourceforge.net/svnroot/java3d-eclipse/org.java3declipse/trunk/
You can check out projects you need. Let me know if you have any problems with that.
---
Aleksandar Ristovski
Hi,
checking out was easy, but attaching the source is a little bit complicated.
The only way I'd expect to do that is the plugin dependencies section. But I cannot change anything ("The current classpath entry belongs to container 'Plug-in Dependencies' which does not allow user modification to source attachments entries.
Same with the Javadoc Location.
Any idea where I can setup the attachment?
Why don't you just deliver the plugin with docs?
Kind regards, Sebastian
I hope setting up javadoc for java3d API (for vecmath.jar, j3dcore.jar and j3dutils.jar) worked? You really need them.
For the rest of the plugins (core, geometry, etc...) there is not so much code yet so for now you can probably simply look at the source (there are comments there). I will be posting instructions on setting everything up soon. Meanwhile, you can use wiki pages and sources as the documentation. Check out the examples and tests as well, they can be of use as a reference.
To answer your question: There are no javadocs in the plug-ins from download section because they are ready to be redistributed with your applications. I will consider posting a development version of core,gemetry,etc... that would contain javadocs (but no promises). For java3d API though, it is unlikely that I will ever post version with java docs. For that you will have to follow the wiki instructions to attach javadocs.
Please see the updated: http://java3d-eclipse.wiki.sourceforge.net/DevelopmentEnvironment and let me know if this clarifies (or not) things.
Hi,
yes that helped.
But one thing what bothers me: When setting up documentation for Java3D, the whole plugin is copied into my workspace, consuming the disc space twice and making updates more difficult.
Look at http://www.informatik.fernuni-hagen.de/import/pi3/personen/pilgrim/gef3d/index.html
There's a Java3D plugin that already contains the docs (as a separate plugin). Maybe you can adopt this way?
Kind regards, Sebastian
Hi Sebastian,
Thank you for the link. I looked at it and this is what I was talking about when I said I was not going to do that :-).
Please take a look at the updated wiki page: http://java3d-eclipse.wiki.sourceforge.net/DevelopmentEnvironment . Instead of "Binary project" you should select "Binary project with linked content" to avoid copying the jars and binaries.
I will, however, look into all this again in the future and try to make it more convenient to set-up.
Thanks,
Aleksandar