Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generate docs for command libraries and fix doclint enable (#2071)

Browse Source
This commit is contained in:
sciencewhiz
2019-11-11 21:38:04 -08:00
committed by Peter Johnson
parent 55a7f2b4ad
commit d748c67a54
3 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
wpilibj/src/main/java/edu/wpi/first/wpilibj/shuffleboard/Shuffleboard.java
View File

@@ -16,7 +16,7 @@ import edu.wpi.first.networktables.NetworkTableInstance;
* example, programmers can specify a specific {@code boolean} value to be displayed with a toggle
* button instead of the default colored box, or set custom colors for that box.
*
* <p>For example, displaying a boolean entry with a toggle button:
* <p>For example, displaying a boolean entry with a toggle button:</p>
* <pre>{@code
* NetworkTableEntry myBoolean = Shuffleboard.getTab("Example Tab")
* .add("My Boolean", false)
@@ -24,7 +24,7 @@ import edu.wpi.first.networktables.NetworkTableInstance;
* .getEntry();
* }</pre>
*
* Changing the colors of the boolean box:
* <p>Changing the colors of the boolean box:</p>
* <pre>{@code
* NetworkTableEntry myBoolean = Shuffleboard.getTab("Example Tab")
* .add("My Boolean", false)
@@ -33,8 +33,8 @@ import edu.wpi.first.networktables.NetworkTableInstance;
* .getEntry();
* }</pre>
*
* Specifying a parent layout. Note that the layout type must <i>always</i> be specified, even if
* the layout has already been generated by a previously defined entry.
* <p>Specifying a parent layout. Note that the layout type must <i>always</i> be specified, even if
* the layout has already been generated by a previously defined entry.</p>
* <pre>{@code
* NetworkTableEntry myBoolean = Shuffleboard.getTab("Example Tab")
* .getLayout("List", "Example List")
@@ -42,7 +42,6 @@ import edu.wpi.first.networktables.NetworkTableInstance;
* .withWidget("Toggle Button")
* .getEntry();
* }</pre>
* </p>
*
* <p>Teams are encouraged to set up shuffleboard layouts at the start of the robot program.</p>
*/