TravSatEE
10-02-2013, 20:03
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 (http://web.joshua-colp.com/travis/)
Some example pages I have changed:
Joystick class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/Joystick.html) (more overview detail, added a diagram, and added method return value ranges)
PIDController class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/PIDController.html) (more detail and reference links)
PIDController.PercentageTolerance class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/PIDController.PercentageTolerance.html) (added the use of MathJax (http://www.mathjax.org/) 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!
The main URL: WPILIBJ Javadoc (http://web.joshua-colp.com/travis/)
Some example pages I have changed:
Joystick class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/Joystick.html) (more overview detail, added a diagram, and added method return value ranges)
PIDController class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/PIDController.html) (more detail and reference links)
PIDController.PercentageTolerance class (http://web.joshua-colp.com/travis/edu/wpi/first/wpilibj/PIDController.PercentageTolerance.html) (added the use of MathJax (http://www.mathjax.org/) 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!