From 7b74842a6e17facdfc847554c6abb4eb8e130a08 Mon Sep 17 00:00:00 2001 From: Project516 <138796702+Project516@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:05:54 -0500 Subject: [PATCH 01/10] =?UTF-8?q?typofix:=20=E2=80=98=20=E2=80=94>=20?= =?UTF-8?q?=E2=80=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index f1f5f841..08532c69 100644 --- a/build.gradle +++ b/build.gradle @@ -1,7 +1,7 @@ plugins { id "java" id "edu.wpi.first.GradleRIO" version "2025.3.1" - id 'com.diffplug.spotless' version '6.12.0' + id 'com.diffplug.spotless' version "6.12.0" id "com.peterabeles.gversion" version "1.10" id "io.freefair.lombok" version "6.6.1" id("com.github.spotbugs") version "6.0.24" From 756f26201299e123936080dd6449c3377234e8ca Mon Sep 17 00:00:00 2001 From: Project516 <138796702+Project516@users.noreply.github.com> Date: Fri, 19 Sep 2025 13:39:16 -0500 Subject: [PATCH 02/10] feat: javadoc configuration --- build.gradle | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/build.gradle b/build.gradle index 08532c69..e137f061 100644 --- a/build.gradle +++ b/build.gradle @@ -201,3 +201,11 @@ tasks.spotbugsMain { setStylesheet("fancy-hist.xsl") } } + +//Javadoc Gradle task configuation +//This will fail unless "io.freefair.lombok" is bumped from 6.6.1 to 6.6.3 +javadoc { + options.addStringOption('Xdoclint:none', '-quiet') + failOnError = false + exclude '**/*.md' +} From 15c6076550d25e2d87aa645ac05c904ad5771e18 Mon Sep 17 00:00:00 2001 From: Project516 <138796702+Project516@users.noreply.github.com> Date: Fri, 19 Sep 2025 18:55:34 +0000 Subject: [PATCH 03/10] bump lombok from 6.6.1 to 6.6.2 and bump googleJavaFormat to 1.15.0, which is what is in the StatesMachineTest branch (commit 5767619271f1fe49ea25e51569bc551a0772ee2f) to allow javadoc Gradle task to build --- build.gradle | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/build.gradle b/build.gradle index e137f061..de348422 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ plugins { id "edu.wpi.first.GradleRIO" version "2025.3.1" id 'com.diffplug.spotless' version "6.12.0" id "com.peterabeles.gversion" version "1.10" - id "io.freefair.lombok" version "6.6.1" + id "io.freefair.lombok" version "6.6.2" id("com.github.spotbugs") version "6.0.24" } @@ -147,7 +147,7 @@ spotless { exclude '**/build/**', '**/build-*/**' } toggleOffOn() - googleJavaFormat("1.7").aosp() + googleJavaFormat("1.15.0").aosp() removeUnusedImports() trimTrailingWhitespace() endWithNewline() From 8773fbd040d7023d3ed5bc1d4d91b1e5ff0fbbae Mon Sep 17 00:00:00 2001 From: Project516 <138796702+Project516@users.noreply.github.com> Date: Fri, 19 Sep 2025 18:56:32 +0000 Subject: [PATCH 04/10] remove unneeded commit --- build.gradle | 1 - 1 file changed, 1 deletion(-) diff --git a/build.gradle b/build.gradle index de348422..73efe7b9 100644 --- a/build.gradle +++ b/build.gradle @@ -203,7 +203,6 @@ tasks.spotbugsMain { } //Javadoc Gradle task configuation -//This will fail unless "io.freefair.lombok" is bumped from 6.6.1 to 6.6.3 javadoc { options.addStringOption('Xdoclint:none', '-quiet') failOnError = false From 5e593ce0d20243191730306e267c81300f3f077c Mon Sep 17 00:00:00 2001 From: project516 Date: Thu, 25 Sep 2025 15:44:56 -0500 Subject: [PATCH 05/10] spotless formating --- .../reefscape/offsets/StateChampsOffsets.java | 4 ++- .../java/frc/spectrumLib/util/ExpCurve.java | 4 ++- .../frc/spectrumLib/vision/Limelight.java | 28 ++++++++++++++----- 3 files changed, 27 insertions(+), 9 deletions(-) diff --git a/src/main/java/frc/reefscape/offsets/StateChampsOffsets.java b/src/main/java/frc/reefscape/offsets/StateChampsOffsets.java index d29f84ae..3ebea1a8 100644 --- a/src/main/java/frc/reefscape/offsets/StateChampsOffsets.java +++ b/src/main/java/frc/reefscape/offsets/StateChampsOffsets.java @@ -68,7 +68,9 @@ private static double meterConverter(double offsetInches) { return meterConversion + halfRobotLength; } - /** @param degrees */ + /** + * @param degrees + */ private static double radianConverter(double offsetDegrees) { double radianConversion = Units.degreesToRadians(offsetDegrees); diff --git a/src/main/java/frc/spectrumLib/util/ExpCurve.java b/src/main/java/frc/spectrumLib/util/ExpCurve.java index 37e14f4a..a77dcaac 100644 --- a/src/main/java/frc/spectrumLib/util/ExpCurve.java +++ b/src/main/java/frc/spectrumLib/util/ExpCurve.java @@ -43,7 +43,9 @@ public ExpCurve(double expVal, double offset, double scalar, double deadzone) { setDeadzone(deadzone); } - /** @param input value to be mapped */ + /** + * @param input value to be mapped + */ @Override public double calculate(double input) { double val = calculateOffset(calculateScalar(calculateExpVal(calculateDeadzone(input)))); diff --git a/src/main/java/frc/spectrumLib/vision/Limelight.java b/src/main/java/frc/spectrumLib/vision/Limelight.java index de8f285d..4864d6c1 100644 --- a/src/main/java/frc/spectrumLib/vision/Limelight.java +++ b/src/main/java/frc/spectrumLib/vision/Limelight.java @@ -125,7 +125,9 @@ public double getVerticalOffset() { return LimelightHelpers.getTY(config.getName()); } - /** @return Whether the LL has any valid targets (April tags or other vision targets) */ + /** + * @return Whether the LL has any valid targets (April tags or other vision targets) + */ public boolean targetInView() { if (!isAttached()) { return false; @@ -133,7 +135,9 @@ public boolean targetInView() { return LimelightHelpers.getTV(config.getName()); } - /** @return whether the LL sees multiple tags or not */ + /** + * @return whether the LL sees multiple tags or not + */ public boolean multipleTagsInView() { if (!isAttached()) { return false; @@ -172,7 +176,9 @@ public double getTargetSize() { /* ::: Pose Retrieval ::: */ - /** @return the corresponding LL Pose3d (MEGATAG1) for the alliance in DriverStation.java */ + /** + * @return the corresponding LL Pose3d (MEGATAG1) for the alliance in DriverStation.java + */ public Pose3d getMegaTag1_Pose3d() { if (!isAttached()) { return new Pose3d(); @@ -184,7 +190,9 @@ public Pose3d getMegaTag1_Pose3d() { return pose3d; } - /** @return the corresponding LL Pose3d (MEGATAG2) for the alliance in DriverStation.java */ + /** + * @return the corresponding LL Pose3d (MEGATAG2) for the alliance in DriverStation.java + */ public Pose2d getMegaTag2_Pose2d() { if (!isAttached()) { return new Pose2d(); @@ -229,7 +237,9 @@ public boolean hasAccuratePose() { return multipleTagsInView() && getTargetSize() > 0.1; } - /** @return the distance of the 2d vector from the camera to closest apriltag */ + /** + * @return the distance of the 2d vector from the camera to closest apriltag + */ public double getDistanceToTagFromCamera() { if (!isAttached()) { return 0; @@ -316,13 +326,17 @@ public void sendInvalidStatus(String message) { * Utility Wrappers */ - /** @return The latest LL results as a LimelightResults object. */ + /** + * @return The latest LL results as a LimelightResults object. + */ @SuppressWarnings("unused") private LimelightResults retrieveJSON() { return LimelightHelpers.getLatestResults(config.name); } - /** @param pipelineIndex use pipeline indexes in {@link VisionConfig} */ + /** + * @param pipelineIndex use pipeline indexes in {@link VisionConfig} + */ public void setLimelightPipeline(int pipelineIndex) { if (!isAttached()) { return; From c77ba3ef196e65bc5517962dd6b5f3f32dbe4eb3 Mon Sep 17 00:00:00 2001 From: project516 <138796702+Project516@users.noreply.github.com> Date: Thu, 25 Sep 2025 16:26:53 -0500 Subject: [PATCH 06/10] add javadoc workflow --- .github/workflows/javadoc.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/javadoc.yml diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml new file mode 100644 index 00000000..d8e9993f --- /dev/null +++ b/.github/workflows/javadoc.yml @@ -0,0 +1,29 @@ +on: + push: + branches: + [ "main" ] + +jobs: + build: + permissions: + contents: write + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v5 + + - name: Set up JDK + uses: actions/setup-java@v5 + with: + distribution: 'temurin' + java-version: '17' + + - name: Generate JavaDoc + run: ./gradlew javadoc + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build/docs/javadoc From 628bedf43523d4e3ce7d799577093cc6828f006f Mon Sep 17 00:00:00 2001 From: project516 <138796702+Project516@users.noreply.github.com> Date: Thu, 25 Sep 2025 16:27:52 -0500 Subject: [PATCH 07/10] Revert "add javadoc workflow" This reverts commit c77ba3ef196e65bc5517962dd6b5f3f32dbe4eb3. My GH Token doesnt have the workflow permission --- .github/workflows/javadoc.yml | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 .github/workflows/javadoc.yml diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml deleted file mode 100644 index d8e9993f..00000000 --- a/.github/workflows/javadoc.yml +++ /dev/null @@ -1,29 +0,0 @@ -on: - push: - branches: - [ "main" ] - -jobs: - build: - permissions: - contents: write - runs-on: ubuntu-latest - - steps: - - name: Checkout repo - uses: actions/checkout@v5 - - - name: Set up JDK - uses: actions/setup-java@v5 - with: - distribution: 'temurin' - java-version: '17' - - - name: Generate JavaDoc - run: ./gradlew javadoc - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v4 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./build/docs/javadoc From 0a508e4de6ecd9587e7a1068bc555ab5f7db8f8e Mon Sep 17 00:00:00 2001 From: project516 <138796702+Project516@users.noreply.github.com> Date: Thu, 25 Sep 2025 16:30:07 -0500 Subject: [PATCH 08/10] upload javadoc.yml to temp folder --- .github/temp/javadoc.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/temp/javadoc.yml diff --git a/.github/temp/javadoc.yml b/.github/temp/javadoc.yml new file mode 100644 index 00000000..fcb38e62 --- /dev/null +++ b/.github/temp/javadoc.yml @@ -0,0 +1,31 @@ +name: Generate JavaDoc and deploy to GitHub Pages + +on: + push: + branches: + [ "main" ] + +jobs: + build: + permissions: + contents: write + runs-on: ubuntu-latest + + steps: + - name: Checkout repo + uses: actions/checkout@v5 + + - name: Set up JDK + uses: actions/setup-java@v5 + with: + distribution: 'temurin' + java-version: '17' + + - name: Generate JavaDoc + run: ./gradlew javadoc + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build/docs/javadoc From 5573d5095903a30f6c019d51da378e6f5c0b1dfd Mon Sep 17 00:00:00 2001 From: Project516 <138796702+Project516@users.noreply.github.com> Date: Thu, 25 Sep 2025 16:31:01 -0500 Subject: [PATCH 09/10] Rename javadoc.yml to javadoc.yml --- .github/{temp => workflows}/javadoc.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{temp => workflows}/javadoc.yml (100%) diff --git a/.github/temp/javadoc.yml b/.github/workflows/javadoc.yml similarity index 100% rename from .github/temp/javadoc.yml rename to .github/workflows/javadoc.yml From b45bd2b9869ea5e6912bf9bfcc48f20a9d6c3ceb Mon Sep 17 00:00:00 2001 From: project516 <138796702+Project516@users.noreply.github.com> Date: Thu, 25 Sep 2025 16:35:44 -0500 Subject: [PATCH 10/10] remove duplicate tag --- src/main/java/frc/spectrumLib/util/Trio.java | 1 - 1 file changed, 1 deletion(-) diff --git a/src/main/java/frc/spectrumLib/util/Trio.java b/src/main/java/frc/spectrumLib/util/Trio.java index c2089443..df81daed 100644 --- a/src/main/java/frc/spectrumLib/util/Trio.java +++ b/src/main/java/frc/spectrumLib/util/Trio.java @@ -59,7 +59,6 @@ public C getThird() { * @param The third object's type. * @param a The first object. * @param b The second object. - * @param b The second object. * @return A trio comprised of the three given objects. */ public static Trio of(A a, B b, C c) {