Clean up doc for Valve classes.

Crossle86 · Crossle86 · commit 121805099d5c · 2025-02-19T10:11:25.000-08:00
diff --git a/src/main/java/Team4450/Lib/LibraryVersion.java b/src/main/java/Team4450/Lib/LibraryVersion.java
@@ -47,7 +47,7 @@ public class LibraryVersion
 	 * of the Jitpack compile when requested and will be automatically made available via JitPack. 
 	 */
 	
-	public static final String version = "4.11.0 (02.18.2025) WPILib=" + WPILibVersion.Version;	
+	public static final String version = "4.11.0 (02.19.2025) WPILib=" + WPILibVersion.Version;	
 	
 	// Private constructor means this class can't be instantiated.
 	private LibraryVersion()
diff --git a/src/main/java/Team4450/Lib/MonitorCompressorPH.java b/src/main/java/Team4450/Lib/MonitorCompressorPH.java
@@ -11,12 +11,12 @@
 import edu.wpi.first.wpilibj.Compressor;
 
 /**
- * Compressor monitoring task. For REV Pneumatics Hub only.
+ * Compressor monitoring task. For REV Pneumatic Hub only.
  * Runs as a separate thread from our MyRobot class. Runs until our
  * program is terminated from the RoboRio. Displays compressor on/off
  * LED on DS. Can also monitor an air pressure sensor and report the
  * pressure to the DS. Assumes compressor is plugged into the first
- * PH, device id 1.
+ * PH, CAN id 1.
  */
 
 public class MonitorCompressorPH extends Thread implements Sendable
diff --git a/src/main/java/Team4450/Lib/ValveDA.java b/src/main/java/Team4450/Lib/ValveDA.java
@@ -40,8 +40,8 @@ public class ValveDA implements Sendable
 	public double           solenoidSlideTime = .02;
 
 	/**
+	 * Create instance of ValveDA class. Assumes CAN Id 0 for CTRE module, Id 1 for REV module.
 	 * @param port Control Module port wired to open/A side of valve. Close/B side is wired to module next port.
-	 * Assumes CAN Id 0 for CTRE module, Id 1 for REV module.
 	 * @param moduleType Pneumatic control module type.
 	 */
 
@@ -62,8 +62,9 @@ public ValveDA(int port, PneumaticsModuleType moduleType)
 	}
 
 	/**
+	 * Create instance of ValveDA class.
 	 * @param canId Control Module CAN Id number, 0 for first CTRE module, 1 for first REV module.
-	 * @param port PCM port wired to open/A side of valve. Close/B side is wired to module next port.
+	 * @param port Control module port wired to open/A side of valve. Close/B side is wired to module next port.
 	 * @param moduleType Pneumatic control module type.
 	 */
 
diff --git a/src/main/java/Team4450/Lib/ValveSA.java b/src/main/java/Team4450/Lib/ValveSA.java
@@ -22,7 +22,9 @@ public class ValveSA implements Sendable
 	private String			name = "ValveSA";
 
 	/**
-	 * @param port DIO port wired to valve. Assumes Control Module CAN Id 0 for CTRE module, Id 1 for REV module.
+	 * Create instance of ValveSA class. Assumes Control Module CAN Id 0 for CTRE module, 
+	 * Id 1 for REV module.
+	 * @param port Control module port wired to valve. 
 	 * @param moduleType Pneumatic control module type.
 	 */
 	public ValveSA(int port, PneumaticsModuleType moduleType)
@@ -41,8 +43,9 @@ public ValveSA(int port, PneumaticsModuleType moduleType)
 	}
 
 	/**
+	 * Create an instance of ValveSA class. 
 	 * @param canId Control Module CAN Id number, 0 for first CTRE module, 1 for first REV module.
-	 * @param port DIO port wired to valve.
+	 * @param port Control module port wired to valve.
 	 * @param moduleType Pneumatic control module type.
 	 */
 	public ValveSA(int canId, int port, PneumaticsModuleType moduleType)
diff --git a/src/main/resources/overview.html b/src/main/resources/overview.html
@@ -3,5 +3,5 @@
 <body>
 <h1 style="font-family: arial">FRC Team 4450 Robot Control Program Utility Library</h1>
 <p style="font-family: arial">Provides utility classes and functions for FRC robot control programs.</p>
-<p style="font-family: arial">Version 4.11.0  (February 18 2025)</p>
+<p style="font-family: arial">Version 4.11.0  (February 19 2025)</p>
 </body>
