From 86acb27e243e046deb908fe3e4dd576c5130b24a Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Fri, 29 May 2020 09:15:46 -0700 Subject: [PATCH] [wpilibc] Fix doxygen comments (#2519) Apply doxygen comments to class instead of frc namespace. Correct references to differential drive. --- .../DifferentialDriveKinematicsConstraint.h | 2 +- .../constraint/MecanumDriveKinematicsConstraint.h | 6 +++--- .../constraint/SwerveDriveKinematicsConstraint.h | 12 ++++++------ .../constraint/SwerveDriveKinematicsConstraint.inc | 13 ++++++------- 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/wpilibc/src/main/native/include/frc/trajectory/constraint/DifferentialDriveKinematicsConstraint.h b/wpilibc/src/main/native/include/frc/trajectory/constraint/DifferentialDriveKinematicsConstraint.h index 260fc4c42f..901bd779a4 100644 --- a/wpilibc/src/main/native/include/frc/trajectory/constraint/DifferentialDriveKinematicsConstraint.h +++ b/wpilibc/src/main/native/include/frc/trajectory/constraint/DifferentialDriveKinematicsConstraint.h @@ -12,13 +12,13 @@ #include "frc/kinematics/DifferentialDriveKinematics.h" #include "frc/trajectory/constraint/TrajectoryConstraint.h" +namespace frc { /** * A class that enforces constraints on the differential drive kinematics. * This can be used to ensure that the trajectory is constructed so that the * commanded velocities for both sides of the drivetrain stay below a certain * limit. */ -namespace frc { class DifferentialDriveKinematicsConstraint : public TrajectoryConstraint { public: DifferentialDriveKinematicsConstraint(DifferentialDriveKinematics kinematics, diff --git a/wpilibc/src/main/native/include/frc/trajectory/constraint/MecanumDriveKinematicsConstraint.h b/wpilibc/src/main/native/include/frc/trajectory/constraint/MecanumDriveKinematicsConstraint.h index 00e66c9710..9eb43d2a9c 100644 --- a/wpilibc/src/main/native/include/frc/trajectory/constraint/MecanumDriveKinematicsConstraint.h +++ b/wpilibc/src/main/native/include/frc/trajectory/constraint/MecanumDriveKinematicsConstraint.h @@ -14,13 +14,13 @@ #include "frc/kinematics/MecanumDriveKinematics.h" #include "frc/trajectory/constraint/TrajectoryConstraint.h" +namespace frc { /** - * A class that enforces constraints on the differential drive kinematics. + * A class that enforces constraints on the mecanum drive kinematics. * This can be used to ensure that the trajectory is constructed so that the - * commanded velocities for both sides of the drivetrain stay below a certain + * commanded velocities for wheels of the drivetrain stay below a certain * limit. */ -namespace frc { class MecanumDriveKinematicsConstraint : public TrajectoryConstraint { public: MecanumDriveKinematicsConstraint(MecanumDriveKinematics kinematics, diff --git a/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.h b/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.h index e7b852f0f9..ece368c6a7 100644 --- a/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.h +++ b/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.h @@ -14,15 +14,15 @@ #include "frc/kinematics/SwerveDriveKinematics.h" #include "frc/trajectory/constraint/TrajectoryConstraint.h" -/** - * A class that enforces constraints on the differential drive kinematics. - * This can be used to ensure that the trajectory is constructed so that the - * commanded velocities for both sides of the drivetrain stay below a certain - * limit. - */ namespace frc { template + +/** + * A class that enforces constraints on the swerve drive kinematics. + * This can be used to ensure that the trajectory is constructed so that the + * commanded velocities of the wheels stay below a certain limit. + */ class SwerveDriveKinematicsConstraint : public TrajectoryConstraint { public: SwerveDriveKinematicsConstraint( diff --git a/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.inc b/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.inc index 63ac59a55b..c36e3e9b45 100644 --- a/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.inc +++ b/wpilibc/src/main/native/include/frc/trajectory/constraint/SwerveDriveKinematicsConstraint.inc @@ -7,16 +7,15 @@ #pragma once -/** - * A class that enforces constraints on the differential drive kinematics. - * This can be used to ensure that the trajectory is constructed so that the - * commanded velocities for both sides of the drivetrain stay below a certain - * limit. - */ - namespace frc { template + +/** + * A class that enforces constraints on the swerve drive kinematics. + * This can be used to ensure that the trajectory is constructed so that the + * commanded velocities of the wheels stay below a certain limit. + */ SwerveDriveKinematicsConstraint::SwerveDriveKinematicsConstraint( frc::SwerveDriveKinematics kinematics, units::meters_per_second_t maxSpeed)