Merge branch 'main' into format-entire-codebase

roboblazers7617 · May 23, 2024 · d255f38 · d255f38
2 parents bf1897a + 11fd25b
commit d255f38
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 9 deletions.
diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -108,3 +108,51 @@ jobs:
       # See: https://github.com/gradle/actions/blob/main/dependency-submission/README.md
       - name: Generate and submit dependency graph
         uses: gradle/actions/dependency-submission@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+
+  build-javadoc:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+
+      # Configure Gradle for optimal use in GiHub Actions, including caching of downloaded dependencies.
+      # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+
+      - name: Build Javadoc with Gradle Wrapper
+        run: ./gradlew javadoc
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          # Path of the directory containing the static assets.
+          path: build/docs/javadoc/
+
+  deploy-javadoc:
+    # Add a dependency to the build job
+    needs: build-javadoc
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action
diff --git a/src/main/java/frc/robot/commands/MechanismCommands.java b/src/main/java/frc/robot/commands/MechanismCommands.java
@@ -126,7 +126,7 @@ public static Command PrepareShoot(Arm arm, Head head, ShootingPosition position
 	 * 
 	 * @param arm
 	 * @param head
-	 * @param position
+	 * @param distance
 	 */
 	public static Command PrepareShoot(Arm arm, Head head, Supplier<Double> distance) {
 		return arm.SetTargets(distance)
@@ -158,7 +158,7 @@ public static Command PrepareShoot(XboxController operatorController, Arm arm, H
 	 * @param operatorController
 	 * @param arm
 	 * @param head
-	 * @param position
+	 * @param distance
 	 * @return
 	 */
 	public static Command PrepareShoot(XboxController operatorController, Arm arm, Head head, Supplier<Double> distance) {
@@ -173,8 +173,6 @@ public static Command PrepareShoot(XboxController operatorController, Arm arm, H
 	 *                subsystem
 	 * @param head
 	 *                subsystem
-	 * @param position
-	 *                position to shoot from
 	 * @return Command
 	 */
 	public static Command Shoot(Arm arm, Head head) {
@@ -208,8 +206,6 @@ public static Command AutonomousShoot(Arm arm, Head head, Drivetrain drivetrain)
 	 *                subsystem
 	 * @param head
 	 *                subsystem
-	 * @param position
-	 *                position to shoot from
 	 * @return Command
 	 */
 	// TODO: Shoot should not take in the position

diff --git a/src/main/java/frc/robot/subsystems/Drivetrain.java b/src/main/java/frc/robot/subsystems/Drivetrain.java
@@ -67,9 +67,6 @@ public class Drivetrain extends SubsystemBase {
 
 	/**
 	 * Initialize {@link SwerveDrive} with the directory provided.
-	 *
-	 * @param directory
-	 *                Directory of swerve drive config files.
 	 */
 	public Drivetrain() {
 		// Configure the Telemetry before creating the SwerveDrive to avoid unnecessary