[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.
This commit is contained in:
Gold856
2026-02-27 23:04:07 -05:00
committed by GitHub
parent c8c68329fa
commit 46a911d50c
28 changed files with 30 additions and 31 deletions

View File

@@ -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);

View File

@@ -40,7 +40,7 @@ class WaitUntilCommand : public CommandHelper<Command, WaitUntilCommand> {
* 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);

View File

@@ -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;

View File

@@ -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;

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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);

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -10,7 +10,7 @@ package org.wpilib.hardware.hal;
* <p>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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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. */

View File

@@ -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 {
/**

View File

@@ -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. */

View File

@@ -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 {
/**

View File

@@ -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. */

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {
/**

View File

@@ -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 {