[docs] Build with JavaDoc 17 and add missing docs (#6220)

Co-authored-by: Sam Carlberg <sam.carlberg@gmail.com>
This commit is contained in:
Tyler Veness
2024-01-19 23:42:09 -08:00
committed by GitHub
parent 9ec27c1202
commit 77c09b9ce2
54 changed files with 3527 additions and 26 deletions

View File

@@ -7,6 +7,9 @@ package edu.wpi.first.hal.can;
import edu.wpi.first.hal.communication.NIRioStatus;
import edu.wpi.first.hal.util.UncleanStatusException;
/**
* Checks the status of a CAN message and throws an exception of the appropriate type if necessary.
*/
public final class CANExceptionFactory {
// FRC Error codes
static final int ERR_CANSessionMux_InvalidBuffer = -44086;

View File

@@ -16,11 +16,16 @@ import java.nio.IntBuffer;
*/
@SuppressWarnings("MethodName")
public class CANJNI extends JNIWrapper {
/** Flag for sending a CAN message once. */
public static final int CAN_SEND_PERIOD_NO_REPEAT = 0;
/** Flag for stopping periodic CAN message sends. */
public static final int CAN_SEND_PERIOD_STOP_REPEATING = -1;
/* Flags in the upper bits of the messageID */
/** Mask for "is frame remote" in message ID. */
public static final int CAN_IS_FRAME_REMOTE = 0x80000000;
/** Mask for "is frame 11 bits" in message ID. */
public static final int CAN_IS_FRAME_11BIT = 0x40000000;
/** Default constructor. */

View File

@@ -4,13 +4,24 @@
package edu.wpi.first.hal.communication;
/** NI RIO status. */
public class NIRioStatus {
/** RIO status offset. */
public static final int kRioStatusOffset = -63000;
/** Success. */
public static final int kRioStatusSuccess = 0;
/** Buffer invalid size. */
public static final int kRIOStatusBufferInvalidSize = kRioStatusOffset - 80;
/** Operation timed out. */
public static final int kRIOStatusOperationTimedOut = -52007;
/** Feature not supported. */
public static final int kRIOStatusFeatureNotSupported = kRioStatusOffset - 193;
/** Resource not initialized. */
public static final int kRIOStatusResourceNotInitialized = -52010;
/** Default constructor. */