Fix typos and incorrect param order in Javadoc (#1740)

This commit is contained in:
Gold856
2025-01-19 22:56:47 -05:00
committed by GitHub
parent ab41d2d1ed
commit 1303a0eaae
29 changed files with 46 additions and 46 deletions

View File

@@ -19,7 +19,7 @@ package org.photonvision.common.configuration;
/**
* Add migrations by adding the SQL commands for each migration sequentially to this array. DO NOT
* edit or delete existing SQL commands. That will lead to producing an icompatible database.
* edit or delete existing SQL commands. That will lead to producing an incompatible database.
*
* <p>You can use multiple SQL statements in one migration step as long as you separate them with a
* semicolon (;).

View File

@@ -28,7 +28,7 @@ import org.photonvision.common.logging.Logger;
* Our blessed images inject the current version via this build workflow:
* https://github.com/PhotonVision/photon-image-modifier/blob/2e5ddb6b599df0be921c12c8dbe7b939ecd7f615/.github/workflows/main.yml#L67
*
* <p>This class provides a convienent abstraction around this
* <p>This class provides a convenient abstraction around this
*/
public class OsImageVersion {
private static final Logger logger = new Logger(OsImageVersion.class, LogGroup.General);

View File

@@ -31,7 +31,7 @@ public enum CameraQuirk {
/** Separate red/blue gain controls available */
@JsonAlias("AWBGain") // remove after https://github.com/PhotonVision/photonvision/issues/1488
AwbRedBlueGain,
/** Will not work with photonvision - Logitec C270 at least */
/** Will not work with photonvision - Logitech C270 at least */
CompletelyBroken,
/** Has adjustable focus and autofocus switch */
AdjustableFocus,

View File

@@ -31,9 +31,9 @@ public class QuirkyCamera {
// SeeCam, which has an odd exposure range
new QuirkyCamera(
0x2560, 0xc128, "See3Cam_24CUG", CameraQuirk.Gain, CameraQuirk.See3Cam_24CUG),
// Chris's older generic "Logitec HD Webcam"
// Chris's older generic "Logitech HD Webcam"
new QuirkyCamera(0x9331, 0x5A3, CameraQuirk.CompletelyBroken),
// Logitec C270
// Logitech C270
new QuirkyCamera(0x825, 0x46D, CameraQuirk.CompletelyBroken),
// A laptop internal camera someone found broken
new QuirkyCamera(0x0bda, 0x5510, CameraQuirk.CompletelyBroken),

View File

@@ -180,7 +180,7 @@ public class USBCameraSource extends VisionSource {
// And update the settables' FrameStaticProps
settables.setVideoMode(oldVideoMode);
// Propogate our updated settables over to the frame provider
// Propagate our updated settables over to the frame provider
((USBFrameProvider) this.usbFrameProvider).updateSettables(this.settables);
}

View File

@@ -145,7 +145,7 @@ public class FileSaveFrameConsumer implements Consumer<CVMat> {
}
/**
* Returns the match Data collected from the NT. eg : Q58 for qualfication match 58. If not in
* Returns the match Data collected from the NT. eg : Q58 for qualification match 58. If not in
* event, returns N/A-0-EVENTNAME
*/
private String getMatchData() {

View File

@@ -444,7 +444,7 @@ public class VisionModule {
return false;
}
visionRunner.runSyncronously(
visionRunner.runSynchronously(
() -> {
settables.setVideoModeInternal(pipelineSettings.cameraVideoModeIndex);
settables.setBrightness(pipelineSettings.cameraBrightness);

View File

@@ -206,7 +206,7 @@ public class VisionModuleChangeSubscriber extends DataChangeSubscriber {
parentModule.startCalibration(deserialized);
parentModule.saveAndBroadcastAll();
} catch (Exception e) {
logger.error("Error deserailizing start-calibration request", e);
logger.error("Error deserializing start-calibration request", e);
}
}

View File

@@ -92,7 +92,7 @@ public class VisionRunner {
}
}
public Future<Void> runSyncronously(Runnable runnable) {
public Future<Void> runSynchronously(Runnable runnable) {
CompletableFuture<Void> future = new CompletableFuture<>();
synchronized (runnableList) {
@@ -109,7 +109,7 @@ public class VisionRunner {
return future;
}
public <T> Future<T> runSyncronously(Callable<T> callable) {
public <T> Future<T> runSynchronously(Callable<T> callable) {
CompletableFuture<T> future = new CompletableFuture<>();
synchronized (runnableList) {

View File

@@ -366,7 +366,7 @@ public class VisionSourceManager {
* CameraConfiguration}'s matchedCameraInfo. We depend on the underlying {@link VisionSource} to
* be robust to disconnected sources at boot
*
* <p>Verify that nickname is unique within the set of desesrialized camera configurations, adding
* <p>Verify that nickname is unique within the set of deserialized camera configurations, adding
* random characters if this isn't the case
*/
protected VisionSource loadVisionSourceFromCamConfig(CameraConfiguration configuration) {

View File

@@ -70,7 +70,7 @@ public abstract class VisionSourceSettables {
public abstract void setGain(int gain);
// Pretty uncommon so instead of abstract this is just a no-op by default
// Overriddenn by cameras with AWB gain support
// Overridden by cameras with AWB gain support
public void setRedGain(int red) {}
public void setBlueGain(int blue) {}

View File

@@ -287,7 +287,7 @@ public class Calibrate3dPipeTest {
}
/**
* Uses a given camera coefficientss matrix set to "undistort" every image file found in a given
* Uses a given camera coefficients matrix set to "undistort" every image file found in a given
* directory and display them. Provides an easy way to visually debug the results of the
* calibration routine. Seems to play havoc with CI and takes a chunk of time, so shouldn't
* usually be left active in tests.

View File

@@ -139,7 +139,7 @@ public class CalibrationRotationPipeTest {
Point[] originalPoints = {new Point(100, 100), new Point(200, 200), new Point(300, 100)};
// Distort the origonal points
// Distort the original points
var distortedOriginalPoints =
OpenCVHelp.distortPoints(
List.of(originalPoints),