Javadoc not showing in Eclipse

1,221 views
Skip to first unread message

JP

unread,
Feb 12, 2012, 4:55:29 PM2/12/12
to ioio-users
Hi!

When I import any of the available IOIO sample projects into Eclipse
the Javadoc documentation of the library shows up. In my own IOIO
project, I get the following note when I place the cursor over a
library call:

Note: This element has no attached Javadoc and the Javadoc could not
be found in the attached source.

Do I need to do something in Eclipse to setup where the documentation
is?

Best regards,
JP

Ytai Ben-Tsvi

unread,
Feb 13, 2012, 12:48:28 AM2/13/12
to ioio-...@googlegroups.com
Basically the generated docs are in IOIOLib/docs
In Eclipse, you can right-click the jar > Properties > Javadoc location and set this location. However, it's not working for me: the next time I enter the same settings screen it gets cleared again...
Anyway, you can just open the javadocs from the location above in a browser window. Also, when you hover over a type or method, there should be a tooltip with the javadoc.


--
You received this message because you are subscribed to the Google Groups "ioio-users" group.
To post to this group, send email to ioio-...@googlegroups.com.
To unsubscribe from this group, send email to ioio-users+...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/ioio-users?hl=en.


Al B

unread,
May 12, 2014, 2:51:41 AM5/12/14
to ioio-...@googlegroups.com

This might be still an issue for some folks so I'm gonna share my workaround.

After I import the IOIO API projects onto my workspace (e.g. IOIOLibAndroid and IOIOLibBT ) which include their /src folder and their JARs (ioiolibandroid.jar and ioiolibt.jar), then I make sure the /src is listed at the top of the order list in the Build Path Properties dialog so it can retrieve the Javadoc from the source.  Otherwise, it is not displayed.  See attached screenshots.

There seems to be another workaround described here though.  Where you basically create and add an ioiolibandroid.jar.properties file that contains 2 properties:
src: relative or absolute path to the source folder (or archive).
doc: relative or absolute path to the javadoc.

HTH!





Ytai Ben-Tsvi

unread,
May 12, 2014, 3:06:36 AM5/12/14
to ioio-...@googlegroups.com
Thanks!
I pushed this change to the main codebase, so that ideally people won't have to do this manually going forward.


--
You received this message because you are subscribed to the Google Groups "ioio-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ioio-users+...@googlegroups.com.

To post to this group, send email to ioio-...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages