diff options
author | Luke Shumaker <lukeshu@lukeshu.com> | 2017-02-21 01:57:06 -0500 |
---|---|---|
committer | Luke Shumaker <lukeshu@lukeshu.com> | 2017-02-21 01:57:06 -0500 |
commit | 9670a734f62f23c982c43697c074563eb2baf9c0 (patch) | |
tree | c364980a0cf833356950ab8fdf61403ef11dde98 /src/org/usfirst/frc/team4272/robotlib/ToggleButton.java | |
parent | 273d09797d76206af2fbbc793cad85fb92665a3a (diff) |
Write javadocs for robotlib.
Diffstat (limited to 'src/org/usfirst/frc/team4272/robotlib/ToggleButton.java')
-rw-r--r-- | src/org/usfirst/frc/team4272/robotlib/ToggleButton.java | 8 |
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; |