Moved C++ comments from source files to headers (#1111)

Also sorted functions in C++ sources to match order in related headers.
This commit is contained in:
Tyler Veness
2018-05-31 20:47:15 -07:00
committed by Peter Johnson
parent d9971a705a
commit 8c680a26f8
234 changed files with 9936 additions and 9309 deletions

View File

@@ -11,28 +11,20 @@
using namespace frc;
/**
* Note that the Spark uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience
* issues such as asymmetric behavior around the deadband or inability to
* saturate the controller in either direction, calibration is recommended.
* The calibration procedure can be found in the Spark User Manual available
* from REV Robotics.
*
* 2.003ms = full "forward"
* 1.55ms = the "high end" of the deadband range
* 1.50ms = center of the deadband range (off)
* 1.46ms = the "low end" of the deadband range
* 0.999ms = full "reverse"
*/
/**
* Constructor for a Spark.
*
* @param channel The PWM channel that the Spark is attached to. 0-9 are
* on-board, 10-19 are on the MXP port
*/
Spark::Spark(int channel) : PWMSpeedController(channel) {
/* Note that the Spark uses the following bounds for PWM values. These values
* should work reasonably well for most controllers, but if users experience
* issues such as asymmetric behavior around the deadband or inability to
* saturate the controller in either direction, calibration is recommended.
* The calibration procedure can be found in the Spark User Manual available
* from REV Robotics.
*
* 2.003ms = full "forward"
* 1.55ms = the "high end" of the deadband range
* 1.50ms = center of the deadband range (off)
* 1.46ms = the "low end" of the deadband range
* 0.999ms = full "reverse"
*/
SetBounds(2.003, 1.55, 1.50, 1.46, .999);
SetPeriodMultiplier(kPeriodMultiplier_1X);
SetSpeed(0.0);