[docs] Add missing JavaDocs (#6146)

This commit is contained in:
Tyler Veness
2024-01-04 08:38:06 -08:00
committed by GitHub
parent 6e58db398d
commit f29a7d2e50
145 changed files with 1106 additions and 94 deletions

View File

@@ -6,6 +6,7 @@ package edu.wpi.first.math.spline;
import org.ejml.simple.SimpleMatrix;
/** Represents a hermite spline of degree 3. */
public class CubicHermiteSpline extends Spline {
private static SimpleMatrix hermiteBasis;
private final SimpleMatrix m_coefficients;

View File

@@ -8,10 +8,10 @@ import edu.wpi.first.math.geometry.Pose2d;
/** Represents a pair of a pose and a curvature. */
public class PoseWithCurvature {
// Represents the pose.
/** Represents the pose. */
public Pose2d poseMeters;
// Represents the curvature.
/** Represents the curvature. */
public double curvatureRadPerMeter;
/**

View File

@@ -6,6 +6,7 @@ package edu.wpi.first.math.spline;
import org.ejml.simple.SimpleMatrix;
/** Represents a hermite spline of degree 5. */
public class QuinticHermiteSpline extends Spline {
private static SimpleMatrix hermiteBasis;
private final SimpleMatrix m_coefficients;

View File

@@ -99,7 +99,10 @@ public abstract class Spline {
* the value of x[2] is the second derivative in the x dimension.
*/
public static class ControlVector {
/** The x components of the control vector. */
public double[] x;
/** The y components of the control vector. */
public double[] y;
/**

View File

@@ -10,6 +10,7 @@ import java.util.Arrays;
import java.util.List;
import org.ejml.simple.SimpleMatrix;
/** Helper class that is used to generate cubic and quintic splines from user provided waypoints. */
public final class SplineHelper {
/** Private constructor because this is a utility class. */
private SplineHelper() {}

View File

@@ -56,6 +56,7 @@ public final class SplineParameterizer {
}
}
/** Exception for malformed splines. */
public static class MalformedSplineException extends RuntimeException {
/**
* Create a new exception with the given message.