Skip to content

Commit 1190aae

Browse files
committed
Update documentation.
1 parent 2da6dec commit 1190aae

File tree

7 files changed

+31
-18
lines changed

7 files changed

+31
-18
lines changed

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/BetterCompass.java

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/*
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
3+
*
4+
* Open Source Software - may be modified and shared by FRC teams. The code must
5+
* be accompanied by the BSD license file in the root directory of the project.
6+
*/
17
package org.usfirst.frc.team2084.smartdashboard.extensions;
28

39
import java.awt.BorderLayout;
@@ -19,6 +25,7 @@
1925
import edu.wpi.first.smartdashboard.types.DataType;
2026

2127
/**
28+
* Compass widget that works better than the default one.
2229
*
2330
* @author Ben Wolsieffer
2431
*/
@@ -82,9 +89,9 @@ public void propertyChanged(Property property) {
8289
compass.setRevolutionDistance(circumference.getValue());
8390
} else if (property == ringColor) {
8491
compass.setRosePaint(ringColor.getValue());
85-
}// else if (property == needleType) {
86-
// compass.setSeriesNeedle((int) needleType.getValue());
87-
// }
92+
} // else if (property == needleType) {
93+
// compass.setSeriesNeedle((int) needleType.getValue());
94+
// }
8895
}
8996

9097
@Override

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/BindableSlider.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015 RobotsByTheC. All rights reserved.
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
33
*
44
* Open Source Software - may be modified and shared by FRC teams. The code must
55
* be accompanied by the BSD license file in the root directory of the project.

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/ParameterCommand.java

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/*
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
3+
*
4+
* Open Source Software - may be modified and shared by FRC teams. The code must
5+
* be accompanied by the BSD license file in the root directory of the project.
6+
*/
17
package org.usfirst.frc.team2084.smartdashboard.extensions;
28

39
import java.awt.BorderLayout;
@@ -20,6 +26,8 @@
2026
import edu.wpi.first.wpilibj.tables.ITable;
2127

2228
/**
29+
* Command that can have a set of parameters that can be changed on the
30+
* SmartDashboard.
2331
*
2432
* @author Ben Wolsieffer
2533
* @author Jeff Copeland
@@ -139,7 +147,7 @@ public void tableChanged(ITable source, String key, ITable value, boolean isNew)
139147
parameters.add(k);
140148
addParameter(s, k, DataType.getType(v));
141149
}
142-
} , true);
150+
}, true);
143151
addedParameterListener = true;
144152
}
145153
}
@@ -155,13 +163,13 @@ private JComponent createTextBox(ITable table, String field, DataType type) {
155163
text = bnf = new BindableNumberField(new BindableTableEntry(table, field));
156164
table.addTableListener(field, (source, key, value, isNew) -> {
157165
bnf.setBindableValue((double) value);
158-
} , true);
166+
}, true);
159167
} else {
160168
BindableStringField bsf;
161169
text = bsf = new BindableStringField(new BindableTableEntry(table, field));
162170
table.addTableListener(field, (source, key, value, isNew) -> {
163171
bsf.setBindableValue((String) value);
164-
} , true);
172+
}, true);
165173
}
166174
panel.add(text, BorderLayout.CENTER);
167175

@@ -175,7 +183,7 @@ private JComponent createCheckBox(ITable table, String field) {
175183

176184
table.addTableListener(field, (source, key, value, isNew) -> {
177185
check.setBindableValue((boolean) value);
178-
} , true);
186+
}, true);
179187

180188
panel.add(label, BorderLayout.WEST);
181189
panel.add(check, BorderLayout.EAST);

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/ParameterCommandType.java

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015 RobotsByTheC. All rights reserved.
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
33
*
44
* Open Source Software - may be modified and shared by FRC teams. The code must
55
* be accompanied by the BSD license file in the root directory of the project.
@@ -8,9 +8,6 @@
88

99
import edu.wpi.first.smartdashboard.types.NamedDataType;
1010

11-
/**
12-
* @author Ben Wolsieffer
13-
*/
1411
public class ParameterCommandType extends NamedDataType {
1512

1613
public static final String LABEL = "Parameter Command";

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/Slider.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015 RobotsByTheC. All rights reserved.
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
33
*
44
* Open Source Software - may be modified and shared by FRC teams. The code must
55
* be accompanied by the BSD license file in the root directory of the project.
@@ -19,6 +19,7 @@
1919
import edu.wpi.first.smartdashboard.types.DataType;
2020

2121
/**
22+
* A slider widget.
2223
*
2324
* @author Ben Wolsieffer
2425
*/

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/WheelControllerDisplay.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015 RobotsByTheC. All rights reserved.
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
33
*
44
* Open Source Software - may be modified and shared by FRC teams. The code must
55
* be accompanied by the BSD license file in the root directory of the project.
@@ -24,6 +24,9 @@
2424
import edu.wpi.first.wpilibj.tables.ITable;
2525

2626
/**
27+
* Display for a wheel controller. It displays the output on a dial, and other
28+
* values as text fields.
29+
*
2730
* @author Ben Wolsieffer
2831
*/
2932
@SuppressWarnings("serial")

src/main/java/org/usfirst/frc/team2084/smartdashboard/extensions/WheelControllerType.java

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015 RobotsByTheC. All rights reserved.
2+
* Copyright (c) 2016 RobotsByTheC. All rights reserved.
33
*
44
* Open Source Software - may be modified and shared by FRC teams. The code must
55
* be accompanied by the BSD license file in the root directory of the project.
@@ -8,9 +8,6 @@
88

99
import edu.wpi.first.smartdashboard.types.NamedDataType;
1010

11-
/**
12-
* @author Ben Wolsieffer
13-
*/
1411
public class WheelControllerType extends NamedDataType {
1512

1613
public static final String LABEL = "Wheel Controller";

0 commit comments

Comments
 (0)