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

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

View File

@@ -211,11 +211,9 @@ class Command {
bool IsScheduled() const;
/**
* Whether the command requires a given subsystem. Named "hasRequirement"
* rather than "requires" to avoid confusion with
* {@link
* edu.wpi.first.wpilibj.command.Command#requires(edu.wpi.first.wpilibj.command.Subsystem)}
* - this may be able to be changed in a few years.
* Whether the command requires a given subsystem. Named "HasRequirement"
* rather than "requires" to avoid confusion with Command::Requires(Subsystem)
* -- this may be able to be changed in a few years.
*
* @param requirement the subsystem to inquire about
* @return whether the subsystem is required

View File

@@ -46,7 +46,8 @@ class CommandGroupBase : public CommandBase {
* @param commands The commands to check
* @return True if all the commands are ungrouped.
*/
static bool RequireUngrouped(wpi::span<const std::unique_ptr<Command>>);
static bool RequireUngrouped(
wpi::span<const std::unique_ptr<Command>> commands);
/**
* Requires that the specified commands not have been already allocated to a
@@ -55,7 +56,7 @@ class CommandGroupBase : public CommandBase {
* @param commands The commands to check
* @return True if all the commands are ungrouped.
*/
static bool RequireUngrouped(std::initializer_list<const Command*>);
static bool RequireUngrouped(std::initializer_list<const Command*> commands);
/**
* Adds the given commands to the command group.

View File

@@ -209,7 +209,7 @@ class CommandScheduler final : public nt::NTSendable,
* <p>Commands will be canceled even if they are not scheduled as
* interruptible.
*
* @param commands the commands to cancel
* @param command the command to cancel
*/
void Cancel(Command* command);
@@ -278,7 +278,7 @@ class CommandScheduler final : public nt::NTSendable,
* that are directly scheduled by the scheduler; it will not work on commands
* inside of CommandGroups, as the scheduler does not see them.
*
* @param commands the command to query
* @param command the command to query
* @return whether the command is currently scheduled
*/
bool IsScheduled(const Command* command) const;

View File

@@ -17,9 +17,9 @@
namespace frc2 {
/**
* A command that starts a notifier to run the given runnable periodically in a
* separate thread. Has no end condition as-is; either subclass it or use {@link
* Command#withTimeout(double)} or
* {@link Command#withInterrupt(BooleanSupplier)} to give it one.
* separate thread. Has no end condition as-is; either subclass it or use
* Command::WithTimeout(double) or Command::WithInterrupt(BooleanSupplier) to
* give it one.
*
* <p>WARNING: Do not use this class unless you are confident in your ability to
* make the executed code thread-safe. If you do not know what "thread-safe"

View File

@@ -47,7 +47,7 @@ class SubsystemBase : public Subsystem,
/**
* Sets the subsystem name of this Subsystem.
*
* @param subsystem subsystem name
* @param name subsystem name
*/
void SetSubsystem(std::string_view name);

View File

@@ -35,8 +35,9 @@ class TrapezoidProfileCommand
* Creates a new TrapezoidProfileCommand that will execute the given
* TrapezoidalProfile. Output will be piped to the provided consumer function.
*
* @param profile The motion profile to execute.
* @param output The consumer for the profile output.
* @param profile The motion profile to execute.
* @param output The consumer for the profile output.
* @param requirements The list of requirements.
*/
TrapezoidProfileCommand(frc::TrapezoidProfile<Distance> profile,
std::function<void(State)> output,
@@ -49,8 +50,9 @@ class TrapezoidProfileCommand
* Creates a new TrapezoidProfileCommand that will execute the given
* TrapezoidalProfile. Output will be piped to the provided consumer function.
*
* @param profile The motion profile to execute.
* @param output The consumer for the profile output.
* @param profile The motion profile to execute.
* @param output The consumer for the profile output.
* @param requirements The list of requirements.
*/
TrapezoidProfileCommand(frc::TrapezoidProfile<Distance> profile,
std::function<void(State)> output,

View File

@@ -25,7 +25,7 @@ class Button : public Trigger {
/**
* Create a new button that is pressed when the given condition is true.
*
* @param isActive Whether the button is pressed.
* @param isPressed Whether the button is pressed.
*/
explicit Button(std::function<bool()> isPressed);

View File

@@ -90,7 +90,7 @@ class Trigger {
* Binds a runnable to execute when the trigger becomes active.
*
* @param toRun the runnable to execute.
* @paaram requirements the required subsystems.
* @param requirements the required subsystems.
*/
Trigger WhenActive(std::function<void()> toRun,
std::initializer_list<Subsystem*> requirements);
@@ -99,7 +99,7 @@ class Trigger {
* Binds a runnable to execute when the trigger becomes active.
*
* @param toRun the runnable to execute.
* @paaram requirements the required subsystems.
* @param requirements the required subsystems.
*/
Trigger WhenActive(std::function<void()> toRun,
wpi::span<Subsystem* const> requirements = {});