From 46a911d50cff05eb5616db004a527f8099c74900 Mon Sep 17 00:00:00 2001 From: Gold856 <117957790+Gold856@users.noreply.github.com> Date: Fri, 27 Feb 2026 23:04:07 -0500 Subject: [PATCH] [docs] Fix various `@see` tags in Javadoc (#8644) Most of these were leftovers from the reorg, the Commands v2 change is from the recent merge from main and fixes our builds again. --- .../src/main/java/org/wpilib/command2/WaitUntilCommand.java | 2 +- .../main/native/include/wpi/commands2/WaitUntilCommand.hpp | 2 +- datalog/src/main/java/org/wpilib/datalog/DataLogJNI.java | 2 +- .../main/java/org/wpilib/hardware/hal/AddressableLEDJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/AnalogJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/CANAPIJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/ConstantsJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/CounterJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/DIOJNI.java | 2 +- .../main/java/org/wpilib/hardware/hal/DriverStationJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/DutyCycleJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/EncoderJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/HAL.java | 5 ++--- hal/src/main/java/org/wpilib/hardware/hal/HALUtil.java | 4 ++-- hal/src/main/java/org/wpilib/hardware/hal/I2CJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/IMUJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/NotifierJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/PWMJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/PortsJNI.java | 2 +- .../java/org/wpilib/hardware/hal/PowerDistributionJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/PowerJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/REVPHJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/SerialPortJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/SimDeviceJNI.java | 2 +- .../main/java/org/wpilib/hardware/hal/SystemServerJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/ThreadsJNI.java | 2 +- .../main/java/org/wpilib/hardware/hal/UsageReportingJNI.java | 2 +- hal/src/main/java/org/wpilib/hardware/hal/can/CANJNI.java | 2 +- 28 files changed, 30 insertions(+), 31 deletions(-) diff --git a/commandsv2/src/main/java/org/wpilib/command2/WaitUntilCommand.java b/commandsv2/src/main/java/org/wpilib/command2/WaitUntilCommand.java index 745936e3fb..6ec08cb4bb 100644 --- a/commandsv2/src/main/java/org/wpilib/command2/WaitUntilCommand.java +++ b/commandsv2/src/main/java/org/wpilib/command2/WaitUntilCommand.java @@ -39,7 +39,7 @@ public class WaitUntilCommand extends Command { * wait. * * @param time the match time after which to end, in seconds - * @see edu.wpi.first.wpilibj.DriverStation#getMatchTime() + * @see org.wpilib.driverstation.DriverStation#getMatchTime() */ public WaitUntilCommand(double time) { this(() -> Timer.getMatchTime() < time); diff --git a/commandsv2/src/main/native/include/wpi/commands2/WaitUntilCommand.hpp b/commandsv2/src/main/native/include/wpi/commands2/WaitUntilCommand.hpp index 5039fb2825..150fab465c 100644 --- a/commandsv2/src/main/native/include/wpi/commands2/WaitUntilCommand.hpp +++ b/commandsv2/src/main/native/include/wpi/commands2/WaitUntilCommand.hpp @@ -40,7 +40,7 @@ class WaitUntilCommand : public CommandHelper { * practice mode, the command will not wait. * * @param time the match time after which to end, in seconds - * @see frc::DriverStation::GetMatchTime() + * @see wpi::DriverStation::GetMatchTime() */ explicit WaitUntilCommand(wpi::units::second_t time); diff --git a/datalog/src/main/java/org/wpilib/datalog/DataLogJNI.java b/datalog/src/main/java/org/wpilib/datalog/DataLogJNI.java index c51ae133ec..1d4759968f 100644 --- a/datalog/src/main/java/org/wpilib/datalog/DataLogJNI.java +++ b/datalog/src/main/java/org/wpilib/datalog/DataLogJNI.java @@ -12,7 +12,7 @@ import org.wpilib.util.runtime.RuntimeLoader; /** * DataLog JNI Functions. * - * @see "datalog/DataLog.h" + * @see "wpi/datalog/DataLog.hpp" */ public class DataLogJNI { static boolean libraryLoaded = false; diff --git a/hal/src/main/java/org/wpilib/hardware/hal/AddressableLEDJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/AddressableLEDJNI.java index aecf33e8a2..9367863a28 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/AddressableLEDJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/AddressableLEDJNI.java @@ -9,7 +9,7 @@ import java.nio.ByteBuffer; /** * Addressable LED HAL JNI Methods. * - * @see "hal/AddressableLED.h" + * @see "wpi/hal/AddressableLED.h" */ public class AddressableLEDJNI extends JNIWrapper { public static final int COLOR_ORDER_RGB = 0; diff --git a/hal/src/main/java/org/wpilib/hardware/hal/AnalogJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/AnalogJNI.java index 7b0f2f5cc8..4cb7702186 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/AnalogJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/AnalogJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Analog Input / Output / Trigger JNI Functions. * - * @see "hal/AnalogInput.h" + * @see "wpi/hal/AnalogInput.h" */ public class AnalogJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/CANAPIJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/CANAPIJNI.java index bf92cbb68e..71c9db1ffe 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/CANAPIJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/CANAPIJNI.java @@ -9,7 +9,7 @@ import org.wpilib.hardware.hal.can.CANReceiveMessage; /** * CAN API HAL JNI Functions. * - * @see "hal/CANAPI.h" + * @see "wpi/hal/CANAPI.h" */ public class CANAPIJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/ConstantsJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/ConstantsJNI.java index 7db35db6ba..b5e698bf5d 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/ConstantsJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/ConstantsJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Constants HAL JNI functions. * - * @see "hal/Constants.h" + * @see "wpi/hal/Constants.h" */ public class ConstantsJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/CounterJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/CounterJNI.java index 734b2b7b3f..490d582612 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/CounterJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/CounterJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Counter HAL JNI functions. * - * @see "hal/Counter.h" + * @see "wpi/hal/Counter.h" */ public class CounterJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/DIOJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/DIOJNI.java index 806b7bd758..57233962ee 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/DIOJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/DIOJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Digital Input/Output (IO) JNI Functions. * - * @see "hal/DIO.h" + * @see "wpi/hal/DIO.h" */ public class DIOJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/DriverStationJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/DriverStationJNI.java index 81fab9161b..7d76707488 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/DriverStationJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/DriverStationJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Driver Station JNI Functions. * - * @see "hal/DriverStation.h" + * @see "wpi/hal/DriverStation.h" */ public class DriverStationJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/DutyCycleJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/DutyCycleJNI.java index 0af1f90dae..c9c743dd71 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/DutyCycleJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/DutyCycleJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * DutyCycle HAL JNI functions. * - * @see "DutyCycle.h" + * @see "wpi/hal/DutyCycle.h" */ public class DutyCycleJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/EncoderJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/EncoderJNI.java index 5d2777b6de..7a96434ad5 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/EncoderJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/EncoderJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Encoder JNI Functions. * - * @see "hal/Encoder.h" + * @see "wpi/hal/Encoder.h" */ public class EncoderJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/HAL.java b/hal/src/main/java/org/wpilib/hardware/hal/HAL.java index 2fd83b3d71..b7880f1bc7 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/HAL.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/HAL.java @@ -10,9 +10,8 @@ import java.util.List; /** * JNI Wrapper for Hardware Abstraction Layer (HAL). * - * @see "hal/HALBase.h" - * @see "hal/Main.h" - * @see "hal/UsageReporting.h" + * @see "wpi/hal/HALBase.h" + * @see "wpi/hal/Main.h" */ public final class HAL extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/HALUtil.java b/hal/src/main/java/org/wpilib/hardware/hal/HALUtil.java index db2eb1d678..a736f42595 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/HALUtil.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/HALUtil.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Hardware Abstraction Layer (HAL) Utilities JNI Functions. * - * @see "hal/HALBase.h" + * @see "wpi/hal/HALBase.h" */ public final class HALUtil extends JNIWrapper { /** A pointer parameter to a method is NULL. */ @@ -109,7 +109,7 @@ public final class HALUtil extends JNIWrapper { * * @param errno errno to get description of * @return description of errno - * @see "std:strerror" + * @see "std::strerror" */ public static native String getHALstrerror(int errno); diff --git a/hal/src/main/java/org/wpilib/hardware/hal/I2CJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/I2CJNI.java index d1543f73c8..dde6f1b840 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/I2CJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/I2CJNI.java @@ -9,7 +9,7 @@ import java.nio.ByteBuffer; /** * I2C HAL JNI functions. * - * @see "I2C.h" + * @see "wpi/hal/I2C.h" */ public class I2CJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/IMUJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/IMUJNI.java index d99570b4c4..57f547e695 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/IMUJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/IMUJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * IMU Functions. * - * @see "hal/IMU.h" + * @see "wpi/hal/IMU.h" */ public class IMUJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/NotifierJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/NotifierJNI.java index fe825fc749..e904f0d444 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/NotifierJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/NotifierJNI.java @@ -10,7 +10,7 @@ package org.wpilib.hardware.hal; *

This class is not meant for direct use by teams. Instead, the org.wpilib.system.Notifier * class, which corresponds to the C++ Notifier class, should be used. * - * @see "hal/Notifier.h" + * @see "wpi/hal/Notifier.h" */ public class NotifierJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/PWMJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/PWMJNI.java index bfa7c7d1bd..a2cb7de521 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/PWMJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/PWMJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * PWM JNI Functions. * - * @see "hal/PWM.h" + * @see "wpi/hal/PWM.h" */ public class PWMJNI extends DIOJNI { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/PortsJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/PortsJNI.java index e6a6257261..9435da7b42 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/PortsJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/PortsJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Ports HAL JNI functions. * - * @see "hal/Ports.h" + * @see "wpi/hal/Ports.h" */ public class PortsJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/PowerDistributionJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/PowerDistributionJNI.java index d4ec220048..9763f08aee 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/PowerDistributionJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/PowerDistributionJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Power Distribution JNI Functions. * - * @see "hal/PowerDistribution.h" + * @see "wpi/hal/PowerDistribution.h" */ public class PowerDistributionJNI extends JNIWrapper { /** Automatically determines the module type. */ diff --git a/hal/src/main/java/org/wpilib/hardware/hal/PowerJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/PowerJNI.java index 211785a0c0..b109803985 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/PowerJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/PowerJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Power HAL JNI Functions. * - * @see "Power.h" + * @see "wpi/hal/Power.h" */ public class PowerJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/REVPHJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/REVPHJNI.java index 456cd09c44..ab77a16438 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/REVPHJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/REVPHJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * REV Pneumatic Hub (PH) HAL JNI functions. * - * @see "REVPH.h" + * @see "wpi/hal/REVPH.h" */ public class REVPHJNI extends JNIWrapper { /** Disabled. */ diff --git a/hal/src/main/java/org/wpilib/hardware/hal/SerialPortJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/SerialPortJNI.java index 223234c74e..bcadb997a8 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/SerialPortJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/SerialPortJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Serial Port JNI HAL functions. * - * @see "SerialPort.h" + * @see "wpi/hal/SerialPort.h" */ public class SerialPortJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/SimDeviceJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/SimDeviceJNI.java index 43ca9d394c..e77ab15a45 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/SimDeviceJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/SimDeviceJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * SimDevice JNI Functions. * - * @see "hal/SimDevice.h" + * @see "wpi/hal/SimDevice.h" */ public class SimDeviceJNI extends JNIWrapper { /** Input to user code from the simulator. */ diff --git a/hal/src/main/java/org/wpilib/hardware/hal/SystemServerJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/SystemServerJNI.java index 6008fbb889..1e6262e8b9 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/SystemServerJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/SystemServerJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * SystemServer JNI Functions. * - * @see "SystemServer.h" + * @see "wpi/hal/SystemServer.h" */ public class SystemServerJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/ThreadsJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/ThreadsJNI.java index a135e5af0c..1ce2bc2e0f 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/ThreadsJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/ThreadsJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Threads HAL JNI Functions. * - * @see "Threads.h" + * @see "wpi/hal/Threads.h" */ public class ThreadsJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/UsageReportingJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/UsageReportingJNI.java index eede683f9b..6d608f184e 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/UsageReportingJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/UsageReportingJNI.java @@ -7,7 +7,7 @@ package org.wpilib.hardware.hal; /** * Usage Reporting JNI Functions. * - * @see "hal/UsageReporting.h" + * @see "wpi/hal/UsageReporting.h" */ public class UsageReportingJNI extends JNIWrapper { /** diff --git a/hal/src/main/java/org/wpilib/hardware/hal/can/CANJNI.java b/hal/src/main/java/org/wpilib/hardware/hal/can/CANJNI.java index fafffc5f06..71db1670b2 100644 --- a/hal/src/main/java/org/wpilib/hardware/hal/can/CANJNI.java +++ b/hal/src/main/java/org/wpilib/hardware/hal/can/CANJNI.java @@ -9,7 +9,7 @@ import org.wpilib.hardware.hal.JNIWrapper; /** * CAN API HAL JNI Functions. * - * @see "hal/CAN.h" + * @see "wpi/hal/CAN.h" */ @SuppressWarnings("MethodName") public class CANJNI extends JNIWrapper {