summaryrefslogtreecommitdiff
path: root/src/org/usfirst/frc/team4272/robotlib/ToggleButton.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/org/usfirst/frc/team4272/robotlib/ToggleButton.java')
-rw-r--r--src/org/usfirst/frc/team4272/robotlib/ToggleButton.java8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/org/usfirst/frc/team4272/robotlib/ToggleButton.java b/src/org/usfirst/frc/team4272/robotlib/ToggleButton.java
index 40367e7..8c15514 100644
--- a/src/org/usfirst/frc/team4272/robotlib/ToggleButton.java
+++ b/src/org/usfirst/frc/team4272/robotlib/ToggleButton.java
@@ -1,5 +1,5 @@
/**
- * Copyright (c) 2015 Luke Shumaker.
+ * Copyright (c) 2015, 2017 Luke Shumaker.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -29,7 +29,11 @@
package org.usfirst.frc.team4272.robotlib;
/**
- * TODO: Write JavaDocs
+ * ToggleButton toggles a value on-button-down.
+ *
+ * In each iteration of the main loop, call the
+ * {@link #update(boolean)} method with the current button state. It
+ * will return the current value of what the button toggles.
*/
public class ToggleButton {
private boolean prev = false;