PDA

View Full Version : 2011 WPILIBJ Java Documentation


Pmaxm00
01-12-2011, 06:45 PM
I got bored today so I tried finding Java Documentation for this years code packages, and I couldn't find anything... SOOOOOOOO I ended up generating it on my own and uploading for public use. Check it out at http://javadoc.waltonrobotics.org/.

davidthefat
01-12-2011, 07:04 PM
Gracias por la esa. Anyways what is the difference from last year's? Is the back end more efficient than last year's was or is it just to be compatible with the Classmates?

Pmaxm00
01-12-2011, 07:30 PM
So far I have not found a difference in the code. Tomorrow I will probably check out to see what the differences are.

Alexander Meyer
01-12-2011, 07:55 PM
The Javadocs are located in the sunspotfrcsdk folder, which on Windows is in C:\Documents and Settings\{user}, and on Linux is in the home folder.

Patrick Chiang
01-13-2011, 12:08 AM
They changed it in so many subtle ways this year. 10 minutes into the coding, I realized that they removed the "sensitivity" parameter of the RobotDrive class. I read and re-read the manual but didn't find anything. Also, there's a new class called the SmartDashboard class (in changelog), but I couldn't find the documentation for it. Confused me until I noticed that the javadocs said "2010" on it.

Patrick Chiang
01-13-2011, 12:28 AM
By the way, your web version does not contain all the documents.

I uploaded a more complete version onto Google projects.

http://frc-2011-javadocs.googlecode.com/files/doc.zip

Pmaxm00
01-14-2011, 12:32 PM
Thanks Patrick, I uploaded that to fix the faults I had. :yikes: :D

Patrick Chiang
01-15-2011, 02:01 AM
Thanks Patrick, I uploaded that to fix the faults I had. :yikes: :D

:D No problem. We're still missing parts of it, like the squawk device libraries. I figured out how to generate javadocs for external library last night but now I can't remember. :eek:

EDIT: Nevermind, I found the javadocs already generated inside the Squawk SDK. How did I miss that?!
Anyway, here's the new link: http://frc-2011-javadocs.googlecode.com/files/javadoc2011.zip

Ryan O
01-16-2011, 05:50 PM
Also, javadocs not being accessible is the type of thing we'd love to see entered into the WPILib Tracker for consideration as a shortcoming to fix - the javadocs are linked into the FRC Eclipse Plug-in Help Contents (though this thread has made me double check what is linked and realize that they are slightly behind update wise, which will be fixed in the next stable release)

Anything else along these lines which you think needs fixing, feel free to put on the Tracker at http://firstforge.wpi.edu/sf/tracker/do/listTrackers/projects.wpilib/tracker

LukeS
01-17-2011, 09:41 PM
So far I have not found a difference in the code. Tomorrow I will probably check out to see what the differences are.

I'd done a diff of a backup of the pre-update code with the new code. I no longer have the diff or the original code, but here is a summary of what I found.

A lot of subtle stuff. A few protocols were changed in ways I don't fully understand. A few places it was adjusted how data was represented (signedness, making sure only so many bits made it onto the network. A lot of stuff was rearranged to make the whole thing more OO; everything's better about extending/implementing the right stuff. There are more built-in drive modes. CANJaguar is now in the library, instead of a separate set of files. These are quite a bit different from the old CANJaguar files, internally; they seem to work about the same, though they have more methods.

Pmaxm00
01-18-2011, 11:22 PM
Anyway, here's the new link: http://frc-2011-javadocs.googlecode.com/files/javadoc2011.zip

Okay, I am currently re-uploading it. How exactly do you generate api/javadoc for all of it? I found a way, but apparently it didn't get everything.

Patrick Chiang
01-19-2011, 12:46 AM
Okay, I am currently re-uploading it. How exactly do you generate api/javadoc for all of it? I found a way, but apparently it didn't get everything.

Heh. There's no need to upload it any more. I figured out later that it's already generated on your computer. Find the Doc folder in your sunspotsdk folder and it should already be there.

Pmaxm00
01-19-2011, 05:39 PM
Ohhhhhh Okay. Eh, I'll still keep it uploaded and up to date just for the heck of it.