Go to Post OUR CNC machine is named Joe, and he has this week of school off. He eats candy instead of electricity. Not so accurate or repeatable, but very easy to re-program. - Not2B [more]
Home
Go Back   Chief Delphi > Technical > Programming > Java
CD-Media   CD-Spy  
portal register members calendar search Today's Posts Mark Forums Read FAQ rules

 
Reply
Thread Tools Rate Thread Display Modes
  #1   Spotlight this post!  
Unread 02-10-2013, 08:03 PM
TravSatEE's Avatar
TravSatEE TravSatEE is offline
Spacecraft Engineer and more
FRC #2035 (Robo Rockin' Bots)
Team Role: Engineer
 
Join Date: Jan 2012
Rookie Year: 2002
Location: Monterey, CA
Posts: 26
TravSatEE is infamous around these partsTravSatEE is infamous around these parts
WPILIBJ Javadoc experimental changes

Our team has quite a few new programmers this year and they have been finding areas of the Javadoc that need some more information to clarify details. I've started working on some changes to the comments in the WPILIBJ to increase the amount of detail in the Javadoc. I am looking for feedback and pages which others would like to see more information.

The main URL: WPILIBJ Javadoc

Some example pages I have changed:
Joystick class (more overview detail, added a diagram, and added method return value ranges)

PIDController class (more detail and reference links)

PIDController.PercentageTolerance class (added the use of MathJax to explain the formula. I think software like MathJax is important and should be used more often, even here on Chief Delphi.)

If there are any particular instances of where you recommend improvements, please post those below. Do the improvement types I have outlined above help you to understand? Thanks for any feedback!
__________________
I have a doctoral degree in electrical engineering. My FIRST mentoring philosophy is to encourage student-led activities and create a level playing field among all teams. I believe this approach results in an exciting game, rather than emphasis on a handful of dominant teams.

FIRST FRC Teams that I have mentored: 612, 342, 2035, and 5104. FIRST FRC Teams that I have helped through build seasons: 4171, 4255, and 5171.

Last edited by TravSatEE : 02-10-2013 at 08:31 PM.
Reply With Quote
Reply


Thread Tools
Display Modes Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump


All times are GMT -5. The time now is 07:50 AM.

The Chief Delphi Forums are sponsored by Innovation First International, Inc.


Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.
Copyright © Chief Delphi