Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-05 03:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

Browse Source 
The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
wpilibOldCommands/src/main/native/include/frc/PIDBase.h
View File

@@ -40,9 +40,9 @@ class PIDBase : public PIDInterface,
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
*/
@@ -52,9 +52,10 @@ class PIDBase : public PIDInterface,
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param f the feedforward coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
*/
@@ -235,7 +236,7 @@ class PIDBase : public PIDInterface,
* Set the percentage error which is considered tolerable for use with
* OnTarget.
*
* @param percentage error which is tolerable
* @param percent error which is tolerable
*/
WPI_DEPRECATED("Use SetPercentTolerance() instead.")
virtual void SetTolerance(double percent);
@@ -244,17 +245,17 @@ class PIDBase : public PIDInterface,
* Set the absolute error which is considered tolerable for use with
* OnTarget.
*
* @param percentage error which is tolerable
* @param absTolerance error which is tolerable
*/
virtual void SetAbsoluteTolerance(double absValue);
virtual void SetAbsoluteTolerance(double absTolerance);
/**
* Set the percentage error which is considered tolerable for use with
* OnTarget.
*
* @param percentage error which is tolerable
* @param percent error which is tolerable
*/
virtual void SetPercentTolerance(double percentValue);
virtual void SetPercentTolerance(double percent);
/**
* Set the number of previous error samples to average for tolerancing. When
@@ -267,7 +268,7 @@ class PIDBase : public PIDInterface,
* @param bufLength Number of previous cycles to average. Defaults to 1.
*/
WPI_DEPRECATED("Use a LinearDigitalFilter as the input.")
virtual void SetToleranceBuffer(int buf = 1);
virtual void SetToleranceBuffer(int bufLength = 1);
/**
* Return true if the error is within the percentage of the total input range,

26
wpilibOldCommands/src/main/native/include/frc/PIDController.h
View File

@@ -37,9 +37,9 @@ class PIDController : public PIDBase, public Controller {
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
@@ -53,9 +53,10 @@ class PIDController : public PIDBase, public Controller {
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param f the feedforward coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
@@ -69,9 +70,9 @@ class PIDController : public PIDBase, public Controller {
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This
@@ -85,9 +86,10 @@ class PIDController : public PIDBase, public Controller {
/**
* Allocate a PID object with the given constants for P, I, D.
*
* @param Kp the proportional coefficient
* @param Ki the integral coefficient
* @param Kd the derivative coefficient
* @param p the proportional coefficient
* @param i the integral coefficient
* @param d the derivative coefficient
* @param f the feedforward coefficient
* @param source The PIDSource object that is used to get values
* @param output The PIDOutput object that is set to the output value
* @param period the loop time for doing calculations in seconds. This

4
wpilibOldCommands/src/main/native/include/frc/buttons/Trigger.h
View File

@@ -23,8 +23,8 @@ class Command;
* It is encouraged that teams write a subclass of Trigger if they want to have
* something unusual (for instance, if they want to react to the user holding
* a button while the robot is reading a certain sensor input). For this, they
* only have to write the {@link Trigger#Get()} method to get the full
* functionality of the Trigger class.
* only have to write the Trigger::Get() method to get the full functionality of
* the Trigger class.
*/
class Trigger : public wpi::Sendable, public wpi::SendableHelper<Trigger> {
public:

4
wpilibOldCommands/src/main/native/include/frc/commands/Command.h
View File

@@ -135,7 +135,7 @@ class Command : public wpi::Sendable, public wpi::SendableHelper<Command> {
* @param subsystem The Subsystem required
* @see Subsystem
*/
void Requires(Subsystem* s);
void Requires(Subsystem* subsystem);
/**
* Starts up the command. Gets the command ready to start.
@@ -214,7 +214,7 @@ class Command : public wpi::Sendable, public wpi::SendableHelper<Command> {
/**
* Checks if the command requires the given Subsystem.
*
* @param system the system
* @param subsystem the subsystem
* @return whether or not the subsystem is required (false if given nullptr)
*/
bool DoesRequire(Subsystem* subsystem) const;

2
wpilibOldCommands/src/main/native/include/frc/commands/Scheduler.h
View File

@@ -42,7 +42,7 @@ class Scheduler : public nt::NTSendable, public wpi::SendableHelper<Scheduler> {
*
* All Subsystems should call this.
*
* @param system the system
* @param subsystem the system
*/
void RegisterSubsystem(Subsystem* subsystem);

6
wpilibOldCommands/src/main/native/include/frc/commands/Subsystem.h
View File

@@ -148,21 +148,21 @@ class Subsystem : public wpi::Sendable, public wpi::SendableHelper<Subsystem> {
void AddChild(std::string_view name, wpi::Sendable& child);
/**
* Associate a {@link Sendable} with this Subsystem.
* Associate a Sendable with this Subsystem.
*
* @param child sendable
*/
void AddChild(std::shared_ptr<wpi::Sendable> child);
/**
* Associate a {@link Sendable} with this Subsystem.
* Associate a Sendable with this Subsystem.
*
* @param child sendable
*/
void AddChild(wpi::Sendable* child);
/**
* Associate a {@link Sendable} with this Subsystem.
* Associate a Sendable with this Subsystem.
*
* @param child sendable
*/

2
wpilibOldCommands/src/main/native/include/frc/commands/WaitCommand.h
View File

@@ -17,7 +17,6 @@ class WaitCommand : public TimedCommand {
/**
* Creates a new WaitCommand with the given name and timeout.
*
* @param name the name of the command
* @param timeout the time before this command "times out"
*/
explicit WaitCommand(units::second_t timeout);
@@ -25,6 +24,7 @@ class WaitCommand : public TimedCommand {
/**
* Creates a new WaitCommand with the given timeout.
*
* @param name the name of the command
* @param timeout the time before this command "times out"
*/
WaitCommand(std::string_view name, units::second_t timeout);