add docs

Talon540Programming · Dec 14, 2023 · 55caaf3 · 55caaf3
1 parent f4f29f0
commit 55caaf3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/main/java/frc/robot/util/LoggedTunableNumber.java b/src/main/java/frc/robot/util/LoggedTunableNumber.java
@@ -43,6 +43,8 @@ public LoggedTunableNumber(String dashboardKey, double defaultValue) {
    * Set the default value of the number. The default value can only be set once.
    *
    * @param defaultValue The default value
+   * @throws IllegalStateException If a default value has already been set either by the constructor
+   *     or by a previous call to this method.
    */
   public void initDefault(double defaultValue) {
     if (this.defaultValue != null) {
@@ -61,6 +63,7 @@ public void initDefault(double defaultValue) {
    * Get the current value, from dashboard if available and in tuning mode.
    *
    * @return The current value
+   * @throws IllegalStateException If a default value hasn't been set yet.
    */
   public double get() {
     if (defaultValue == null) {