diff options
Diffstat (limited to 'src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java')
| -rw-r--r-- | src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java b/src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java index 38e64e0..38f994b 100644 --- a/src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java +++ b/src/org/usfirst/frc/team4272/robotlib/SendablePIDOutput.java @@ -1,6 +1,6 @@ /** * Copyright (c) 2012 Precise Path Robotics, Inc - * Copyright (c) 2015 Luke Shumaker + * Copyright (c) 2015, 2017 Luke Shumaker * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -23,12 +23,17 @@ import edu.wpi.first.wpilibj.PIDOutput; import edu.wpi.first.wpilibj.smartdashboard.SmartDashboard; /** - * TODO: Write JavaDocs + * SendablePIDOutput wraps a {@link PIDOutput}, sending the setpoint + * to the {@link SmartDashboard}; which is useful for debugging. */ public class SendablePIDOutput implements PIDOutput { PIDOutput o; String n; + /** + * @param name The name of the value in the SmartDashboard. + * @param out The actual PIDOutput to write to. + */ public SendablePIDOutput(String name, PIDOutput out) { n = name; o = out; |