Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-27 02:01:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Use misspell to fix spelling errors (NFC) (#2674)

Browse Source
This commit is contained in:
sciencewhiz
2020-08-31 00:33:11 -07:00
committed by GitHub
parent ad6c8b882e
commit 3e41d92c18
64 changed files with 119 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibc/src/main/native/include/frc/AddressableLED.h
View File

@@ -151,7 +151,7 @@ class AddressableLED : public ErrorBase {
/**
* Starts the output.
*
* <p>The output writes continously.
* <p>The output writes continuously.
*/
void Start();

4
wpilibc/src/main/native/include/frc/Notifier.h
View File

@@ -135,9 +135,9 @@ class Notifier : public ErrorBase {
void StartPeriodic(units::second_t period);
/**
* Stop timer events from occuring.
* Stop timer events from occurring.
*
* Stop any repeating timer events from occuring. This will also remove any
* Stop any repeating timer events from occurring. This will also remove any
* single notification events from the queue.
*
* If a timer-based call to the registered handler is in progress, this

8
wpilibc/src/main/native/include/frc/PIDController.h
View File

@@ -48,7 +48,7 @@ class PIDController : public PIDBase, public Controller {
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
* differential terms. The default is 0.05 (50ms).
*/
WPI_DEPRECATED("Use frc2::PIDController class instead.")
PIDController(double p, double i, double d, PIDSource* source,
@@ -64,7 +64,7 @@ class PIDController : public PIDBase, public Controller {
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
* differential terms. The default is 0.05 (50ms).
*/
WPI_DEPRECATED("Use frc2::PIDController class instead.")
PIDController(double p, double i, double d, double f, PIDSource* source,
@@ -80,7 +80,7 @@ class PIDController : public PIDBase, public Controller {
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
* differential terms. The default is 0.05 (50ms).
*/
WPI_DEPRECATED("Use frc2::PIDController class instead.")
PIDController(double p, double i, double d, PIDSource& source,
@@ -96,7 +96,7 @@ class PIDController : public PIDBase, public Controller {
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
* particularly affects calculations of the integral and
* differental terms. The default is 0.05 (50ms).
* differential terms. The default is 0.05 (50ms).
*/
WPI_DEPRECATED("Use frc2::PIDController class instead.")
PIDController(double p, double i, double d, double f, PIDSource& source,

2
wpilibc/src/main/native/include/frc/RobotDrive.h
View File

@@ -349,7 +349,7 @@ class RobotDrive : public MotorSafety {
/**
* Holonomic Drive method for Mecanum wheeled robots.
*
* This is an alias to MecanumDrive_Polar() for backward compatability
* This is an alias to MecanumDrive_Polar() for backward compatibility
*
* @param magnitude The speed that the robot should drive in a given
* direction. [-1.0..1.0]

6
wpilibc/src/main/native/include/frc/SerialPort.h
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. */
@@ -106,7 +106,7 @@ class SerialPort : public ErrorBase {
* Enable termination and specify the termination character.
*
* Termination is currently only implemented for receive.
* When the the terminator is recieved, the Read() or Scanf() will return
* When the the terminator is received, the Read() or Scanf() will return
* fewer bytes than requested, stopping after the terminator.
*
* @param terminator The character to use for termination.
@@ -169,7 +169,7 @@ class SerialPort : public ErrorBase {
*
* Specify the amount of data that can be stored before data
* from the device is returned to Read or Scanf. If you want
* data that is recieved to be returned immediately, set this to 1.
* data that is received to be returned immediately, set this to 1.
*
* It the buffer is not filled before the read timeout expires, all
* data that has been received so far will be returned.

4
wpilibc/src/main/native/include/frc/Ultrasonic.h
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. */
@@ -132,7 +132,7 @@ class Ultrasonic : public ErrorBase,
* the ultrasonic sensors. This scheduling method assures that
* the sensors are non-interfering because no two sensors fire
* at the same time. If another scheduling algorithm is
* prefered, it can be implemented by pinging the sensors
* preferred, it can be implemented by pinging the sensors
* manually and waiting for the results to come back.
*/
static void SetAutomaticMode(bool enabling);

2
wpilibc/src/main/native/include/frc/controller/RamseteController.h
View File

@@ -57,7 +57,7 @@ class RamseteController {
/**
* Construct a Ramsete unicycle controller. The default arguments for
* b and zeta of 2.0 and 0.7 have been well-tested to produce desireable
* b and zeta of 2.0 and 0.7 have been well-tested to produce desirable
* results.
*/
RamseteController() : RamseteController(2.0, 0.7) {}

9
wpilibc/src/main/native/include/frc/drive/DifferentialDrive.h
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. */
@@ -191,7 +191,7 @@ class DifferentialDrive : public RobotDriveBase,
void SetQuickStopAlpha(double alpha);
/**
* Gets if the power sent to the right side of the drivetrain is multipled by
* Gets if the power sent to the right side of the drivetrain is multiplied by
* -1.
*
* @return true if the right side is inverted
@@ -200,9 +200,10 @@ class DifferentialDrive : public RobotDriveBase,
/**
* Sets if the power sent to the right side of the drivetrain should be
* multipled by -1.
* multiplied by -1.
*
* @param rightSideInverted true if right side power should be multipled by -1
* @param rightSideInverted true if right side power should be multiplied by
* -1
*/
void SetRightSideInverted(bool rightSideInverted);

9
wpilibc/src/main/native/include/frc/drive/MecanumDrive.h
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. */
@@ -116,7 +116,7 @@ class MecanumDrive : public RobotDriveBase,
void DrivePolar(double magnitude, double angle, double zRotation);
/**
* Gets if the power sent to the right side of the drivetrain is multipled by
* Gets if the power sent to the right side of the drivetrain is multiplied by
* -1.
*
* @return true if the right side is inverted
@@ -125,9 +125,10 @@ class MecanumDrive : public RobotDriveBase,
/**
* Sets if the power sent to the right side of the drivetrain should be
* multipled by -1.
* multiplied by -1.
*
* @param rightSideInverted true if right side power should be multipled by -1
* @param rightSideInverted true if right side power should be multiplied by
* -1
*/
void SetRightSideInverted(bool rightSideInverted);

4
wpilibc/src/main/native/include/frc/shuffleboard/ShuffleboardWidget.h
View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2018-2019 FIRST. All Rights Reserved. */
/* Copyright (c) 2018-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. */
@@ -62,7 +62,7 @@ class ShuffleboardWidget : public ShuffleboardComponent<Derived> {
* Sets the type of widget used to display the data. If not set, the default
* widget type will be used. This method should only be used to use a widget
* that does not come built into Shuffleboard (i.e. one that comes with a
* custom or thrid-party plugin). To use a widget that is built into
* custom or third-party plugin). To use a widget that is built into
* Shuffleboard, use {@link #withWidget(WidgetType)} and {@link
* BuiltInWidgets}.
*