From 02fb850761b19017a820b8dae7af3f00ccb3ade5 Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Sun, 19 Jan 2020 16:26:44 -0600 Subject: [PATCH] Add new speed controllers to shuffleboard docs (#2288) Also fix java links in C++ docs and a few typos. --- .../include/frc/shuffleboard/BuiltInWidgets.h | 83 +++++++++---------- .../wpilibj/shuffleboard/BuiltInWidgets.java | 8 +- 2 files changed, 44 insertions(+), 47 deletions(-) diff --git a/wpilibc/src/main/native/include/frc/shuffleboard/BuiltInWidgets.h b/wpilibc/src/main/native/include/frc/shuffleboard/BuiltInWidgets.h index 8e666b74ec..df943b2e11 100644 --- a/wpilibc/src/main/native/include/frc/shuffleboard/BuiltInWidgets.h +++ b/wpilibc/src/main/native/include/frc/shuffleboard/BuiltInWidgets.h @@ -1,5 +1,5 @@ /*----------------------------------------------------------------------------*/ -/* Copyright (c) 2018-2019 FIRST. All Rights Reserved. */ +/* Copyright (c) 2018-2020 FIRST. All Rights Reserved. */ /* Open Source Software - may be modified and shared by FRC teams. The code */ /* must be accompanied by the FIRST BSD license file in the root directory of */ /* the project. */ @@ -144,7 +144,7 @@ enum class BuiltInWidgets { *
Supported types: * *
Custom properties: * @@ -163,9 +163,8 @@ enum class BuiltInWidgets { */ kVoltageView, /** - * Displays a {@link edu.wpi.first.wpilibj.PowerDistributionPanel - * PowerDistributionPanel}.
Supported types:
@@ -176,49 +175,49 @@ enum class BuiltInWidgets { */ kPowerDistributionPanel, /** - * Displays a {@link edu.wpi.first.wpilibj.smartdashboard.SendableChooser - * SendableChooser} with a dropdown combo box with a list of options. + * Displays a SendableChooser with a dropdown combo box with a list of + * options. *
Supported types: * *
This widget has no custom properties. */ kComboBoxChooser, /** - * Displays a {@link edu.wpi.first.wpilibj.smartdashboard.SendableChooser - * SendableChooser} with a toggle button for each available option. + * Displays a SendableChooserwith a toggle button for each available option. *
Supported types: * *
This widget has no custom properties. */ kSplitButtonChooser, /** - * Displays an {@link edu.wpi.first.wpilibj.Encoder} displaying its speed, - * total travelled distance, and its distance per tick.
Supported types: + * Displays an Encoder displaying its speed, + * total traveled distance, and its distance per tick.
Supported types: * *
This widget has no custom properties. */ kEncoder, /** - * Displays a {@link edu.wpi.first.wpilibj.SpeedController SpeedController}. + * Displays a SpeedController. * The speed controller will be controllable from the dashboard when test mode * is enabled, but will otherwise be view-only.
Supported types: *
Custom properties: *
@@ -231,10 +230,8 @@ enum class BuiltInWidgets { /** * Displays a command with a toggle button. Pressing the button will start the * command, and the button will automatically release when the command - * completes.
Supported types:
@@ -280,10 +277,8 @@ enum class BuiltInWidgets { kAccelerometer, /** * Displays a 3-axis accelerometer with a number bar for each axis' - * accleration.
Supported types:
@@ -302,8 +297,8 @@ enum class BuiltInWidgets { * Displays a gyro with a dial from 0 to 360 degrees. *
Supported types: * *
Custom properties: @@ -319,8 +314,7 @@ enum class BuiltInWidgets { kGyro, /** * Displays a relay with toggle buttons for each supported mode (off, on, - * forward, reverse).
Supported types:
@@ -348,7 +342,7 @@ enum class BuiltInWidgets { * Displays a mecanum drive with a widget that displays the speed of each * wheel, and vectors for the direction and rotation of the drivebase. The * widget will be controllable if the robot is in test mode.
Supported - * types:
@@ -361,8 +355,7 @@ enum class BuiltInWidgets { * Displays a camera stream. *
Supported types: * *
Custom properties: *
diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/shuffleboard/BuiltInWidgets.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/shuffleboard/BuiltInWidgets.java index 14742e55db..b9a1939ede 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/shuffleboard/BuiltInWidgets.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/shuffleboard/BuiltInWidgets.java @@ -1,5 +1,5 @@ /*----------------------------------------------------------------------------*/ -/* Copyright (c) 2018 FIRST. All Rights Reserved. */ +/* Copyright (c) 2018-2020 FIRST. All Rights Reserved. */ /* Open Source Software - may be modified and shared by FRC teams. The code */ /* must be accompanied by the FIRST BSD license file in the root directory of */ /* the project. */ @@ -208,7 +208,10 @@ public enum BuiltInWidgets implements WidgetType { *
  • {@link edu.wpi.first.wpilibj.PWMSpeedController}
    • *
  • {@link edu.wpi.first.wpilibj.DMC60}
    • *
  • {@link edu.wpi.first.wpilibj.Jaguar}
    • + *
  • {@link edu.wpi.first.wpilibj.PWMSparkMax}
    • + *
  • {@link edu.wpi.first.wpilibj.PWMTalonFX}
    • *
  • {@link edu.wpi.first.wpilibj.PWMTalonSRX}
    • + *
  • {@link edu.wpi.first.wpilibj.PWMVenom}
    • *
  • {@link edu.wpi.first.wpilibj.PWMVictorSPX}
    • *
  • {@link edu.wpi.first.wpilibj.SD540}
    • *
  • {@link edu.wpi.first.wpilibj.Spark}
    • @@ -216,6 +219,7 @@ public enum BuiltInWidgets implements WidgetType { *
  • {@link edu.wpi.first.wpilibj.Victor}
    • *
  • {@link edu.wpi.first.wpilibj.VictorSP}
    • *
  • {@link edu.wpi.first.wpilibj.SpeedControllerGroup}
    • + *
  • Any custom subclass of {@code SpeedController}
    • * *
    Custom properties: *
    @@ -283,7 +287,7 @@ public enum BuiltInWidgets implements WidgetType { */ kAccelerometer("Accelerometer"), /** - * Displays a 3-axis accelerometer with a number bar for each axis' accleration. + * Displays a 3-axis accelerometer with a number bar for each axis' acceleration. *
    Supported types: *