I’ve found the WPILIB docs, but was wondering
if there something that describes the fields used for
the modules.
I’m used to C, C++ & Unix where there is a description
of the fields.
Thanks in advance,
When you get to the api documentation, select a class from the list on the lower left. This will tell you all about the methods and variables and arguments created in that class, and links to those inherited from parent classes and interfaces.
Yes, so as an example.
If I click on edu.wpi.cscore, select the class usbcamera, and go to the
constructor UsbCamera(String name, int dev)
In other docs it will define what the “name” & “dev” represents.
I do happen to know the answer for this constructor but some, where I
haven’t seen an example I am a little sketchy on.
I found this link to team 2168’s copy of the Javadocs. If you click on a constructor or other method it will take you to the source code for that method, and the lines above provide a bit more info (one-liners) as to what the method does and what the arguments mean.
This has been fixed in the beta going on right now. You can find the beta docs here: http://first.wpi.edu/FRC/roborio/beta/docs/java/
Try one like AnalogGyro, that will have more info.
FYI, if you haven’t played with auto-generated javadoc, I’d recommend looking into it, it’s pretty slick (IMO). We keep it for our common year-to-year code so new students have a familiar-looking reference as to what code already exists with our team.
[RIGHT]תודה אוסטין[/RIGHT]
Wow, very much appreciated.
Thank you and the team for all your hard work.