Log in

View Full Version : Integrate the API into Eclipse


Jalerre
03-01-2015, 17:27
I was wondering if there was any way to integrate the 2015 API into Eclipse similar to how it was in NetBeans. I enjoyed the convenience of having it built right into the IDE that way if I needed information on a class or how to use a particular method I could just click the First logo and jump into the API. I know in previous years that when you installed the plugins it also installed the API but I just finished setting up Eclipse and was disappointed to see that it wasn't there (but I was very happy to see some other things like RobotBuilder and SmartDashboard simulation built into the IDE). Is it possible to do it or will I just have to keep the API open in another window when programming?

wmarshall11
03-01-2015, 17:31
Select what you want to know about, hover for documentation, right-click and Go To Declaration for source code. Doesn't get much easier than that.

Jalerre
03-01-2015, 17:36
Select what you want to know about, hover for documentation, right-click and Go To Declaration for source code. Doesn't get much easier than that.

Well I already knew that. That works well when you already know what class you want to use for something but there are times when I don't know what the name is for a particular class that I need to use. Also I'm guessing that WPI made some changes to some classes that I already knew so I'm going to need to look that up as well.

virtuald
03-01-2015, 17:56
It does appear that they installed the javadocs in ~/wpilib, but it's not clear how the integration works.

cdewane
03-01-2015, 21:10
Here's how to add the Javadoc for wpilib:

- Find wpilib under the project name in Project Explorer
- Right click wpilib and select Properties
- On the left click on Javadoc Location
- On the right select the Javadoc URL radio button
- Enter "file:/C:/Users/<user name>/wpilib/java/current/javadoc/" or use the browse button. (This is the Windows location)
- Click OK and enjoy
- Now if you hover the mouse over any of the wpilib classes or methods in the editor, the Javadoc will appear in a popup window.

ThomasClark
03-01-2015, 21:12
Not sure if this is what you're looking for, but you can browse all of the classes using Eclipse's Project Explorer, which is in the leftmost panel by default.
http://i.imgur.com/hueo2xG.png

Jeanne Boyarsky
03-01-2015, 21:50
If you want the full JavaDoc in a browser integrated in Eclipse (which is what NetBeans gave us) rather than the part of the JavaDoc relevant to a specific class:

Window > Show View > Other > Internal Web Browser
This gives you a browser embedded in Eclipse.

Then type the URL:
<User Home>/wpilib/java/current/javadoc/index.html

It looks like this. (I haven't updated from the beta to current yet so my URL is a tiny bit different in the screenshot than yours will be.)
http://s17.postimg.org/ka51xn1en/javadoc.jpg

magnets
03-01-2015, 21:53
The JavaDoc has some incorrect documentation. Where can I submit a bug report?

RufflesRidge
03-01-2015, 22:09
The JavaDoc has some incorrect documentation. Where can I submit a bug report?

https://usfirst.collab.net/sf/tracker/do/listTrackers/projects.wpilib/tracker