Add missing references to f in PIDSubsystem javadoc (#2318)

This commit is contained in:
sciencewhiz
2020-01-31 19:18:17 -08:00
committed by GitHub
parent 20e6c04059
commit 42da07396c
2 changed files with 11 additions and 11 deletions

View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2020 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -66,7 +66,7 @@ public abstract class PIDSubsystem extends Subsystem {
}
/**
* Instantiates a {@link PIDSubsystem} that will use the given p, i and d values.
* Instantiates a {@link PIDSubsystem} that will use the given p, i, d, and f values.
*
* @param name the name
* @param p the proportional value
@@ -82,7 +82,7 @@ public abstract class PIDSubsystem extends Subsystem {
}
/**
* Instantiates a {@link PIDSubsystem} that will use the given p, i and d values. It will also
* Instantiates a {@link PIDSubsystem} that will use the given p, i, d, and f values. It will also
* space the time between PID loop calculations to be equal to the given period.
*
* @param name the name
@@ -114,9 +114,9 @@ public abstract class PIDSubsystem extends Subsystem {
}
/**
* Instantiates a {@link PIDSubsystem} that will use the given p, i and d values. It will use the
* class name as its name. It will also space the time between PID loop calculations to be equal
* to the given period.
* Instantiates a {@link PIDSubsystem} that will use the given p, i, d, and f values. It will use
* the class name as its name. It will also space the time between PID loop calculations to be
* equal to the given period.
*
* @param p the proportional value
* @param i the integral value