Added GearPlacerServo subsystem and added some Javadocs. #4
Conversation
src/com/nutrons/nu17/RobotMap.java
Outdated
| public static final int ULTRASONIC_TX = 1; | ||
|
|
||
| // Port of gyro | ||
| public static final int GYRO = 0; |
There was a problem hiding this comment.
We know the RobotMap class is full of port numbers, eliminate that from the comments throughout the class
|
|
||
| /** | ||
| * | ||
| * Command to lower the gear placer to safely drive. |
There was a problem hiding this comment.
We know this is a command. Write the purpose only
|
|
||
| /** | ||
| * | ||
| * Command that brings gear placer up to give the lift a gear. |
There was a problem hiding this comment.
Don't label as a command in the docs
| import edu.wpi.first.wpilibj.command.Subsystem; | ||
|
|
||
| /** | ||
| * Similar to GearPlacer class but uses a servo instead. |
There was a problem hiding this comment.
Don't reference another class without an explicit JavaDoc link.
| package com.nutrons.nu17; | ||
|
|
||
| public class RobotMap { | ||
|
|
There was a problem hiding this comment.
The bit that said they were wheels was helpful. Add a comment:
// Wheel motors
src/com/nutrons/nu17/RobotMap.java
Outdated
| public static final int BACK_RIGHT = 3; | ||
|
|
||
| // Ports of intake | ||
| public static final int ROLLER_A = 0; |
There was a problem hiding this comment.
Which ones are A and B? Top/Bottom? Left/Right? Specify. If you don't know, put that in a TODO comment
src/com/nutrons/nu17/RobotMap.java
Outdated
| public static final int MICRO_SWITCH = 0; | ||
|
|
||
| // Ports of encoders | ||
| public static final int DT_ENCODER_1 = 1; |
There was a problem hiding this comment.
A number tells us nothing. Where are these on the robot?
There was a problem hiding this comment.
We'll be using CANTalons so we won't need these anymore.
| public static final int SHOOT_ENCODER_2 = 1; | ||
|
|
||
| // Port of joysticks | ||
| public static final int JOYSTICK1 = 0; |
There was a problem hiding this comment.
which joysticks? The number does not tell me anything
|
|
||
| import com.nutrons.nu17.Robot; | ||
|
|
||
| import edu.wpi.first.wpilibj.command.Command; |
There was a problem hiding this comment.
These descriptions are for commands. Write them like commands i.e. "Raise the gear placer" instead of "Raises the gear placer"
|
|
||
| /** | ||
| * Similar to GearPlacer class but uses a servo instead. | ||
| * Similar to {@link GearPlacer} class but uses a servo instead. |
There was a problem hiding this comment.
Perhaps this should extend the GearPlacer class or alternately you should have an interface that abstracts over both.
…arPlacer and dumbed down constants in RobotMap.
|
@sytect Fix merge conflicts |
No description provided.