mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-27 02:01:42 +00:00
[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:
@@ -72,7 +72,6 @@ class FieldObject2d {
|
||||
* Set multiple poses from an array of Pose objects.
|
||||
* The total number of poses is limited to 85.
|
||||
*
|
||||
* @param obj Object entry
|
||||
* @param poses array of 2D poses
|
||||
*/
|
||||
void SetPoses(std::initializer_list<Pose2d> poses);
|
||||
@@ -95,7 +94,6 @@ class FieldObject2d {
|
||||
/**
|
||||
* Get multiple poses.
|
||||
*
|
||||
* @param obj Object entry
|
||||
* @param out output SmallVector to hold 2D poses
|
||||
* @return span referring to output SmallVector
|
||||
*/
|
||||
|
||||
@@ -48,6 +48,7 @@ class Mechanism2d : public nt::NTSendable,
|
||||
*
|
||||
* @param width the width
|
||||
* @param height the height
|
||||
* @param backgroundColor the background color
|
||||
*/
|
||||
Mechanism2d(double width, double height,
|
||||
const Color8Bit& backgroundColor = {0, 0, 32});
|
||||
|
||||
@@ -53,7 +53,7 @@ class MechanismLigament2d : public MechanismObject2d {
|
||||
/**
|
||||
* Set the ligament's angle relative to its parent.
|
||||
*
|
||||
* @param degrees the angle
|
||||
* @param angle the angle
|
||||
*/
|
||||
void SetAngle(units::degree_t angle);
|
||||
|
||||
@@ -67,7 +67,7 @@ class MechanismLigament2d : public MechanismObject2d {
|
||||
/**
|
||||
* Set the line thickness.
|
||||
*
|
||||
* @param weight the line thickness
|
||||
* @param lineWidth the line thickness
|
||||
*/
|
||||
void SetLineWeight(double lineWidth);
|
||||
|
||||
|
||||
@@ -114,8 +114,8 @@ class SmartDashboard {
|
||||
* In order for the value to appear in the dashboard, it must be registered
|
||||
* with SendableRegistry. WPILib components do this automatically.
|
||||
*
|
||||
* @param keyName the key
|
||||
* @param value the value
|
||||
* @param key the key
|
||||
* @param data the value
|
||||
*/
|
||||
static void PutData(std::string_view key, wpi::Sendable* data);
|
||||
|
||||
@@ -167,6 +167,7 @@ class SmartDashboard {
|
||||
* If the key is not found, returns the default value.
|
||||
*
|
||||
* @param keyName the key
|
||||
* @param defaultValue the default value to set if key doesn't exist
|
||||
* @return the value
|
||||
*/
|
||||
static bool GetBoolean(std::string_view keyName, bool defaultValue);
|
||||
@@ -198,6 +199,7 @@ class SmartDashboard {
|
||||
* If the key is not found, returns the default value.
|
||||
*
|
||||
* @param keyName the key
|
||||
* @param defaultValue the default value to set if the key doesn't exist
|
||||
* @return the value
|
||||
*/
|
||||
static double GetNumber(std::string_view keyName, double defaultValue);
|
||||
@@ -230,6 +232,7 @@ class SmartDashboard {
|
||||
* If the key is not found, returns the default value.
|
||||
*
|
||||
* @param keyName the key
|
||||
* @param defaultValue the default value to set if the key doesn't exist
|
||||
* @return the value
|
||||
*/
|
||||
static std::string GetString(std::string_view keyName,
|
||||
@@ -418,7 +421,6 @@ class SmartDashboard {
|
||||
* complex data object.
|
||||
*
|
||||
* @param keyName the key
|
||||
* @param value the object to retrieve the value into
|
||||
*/
|
||||
static std::shared_ptr<nt::Value> GetValue(std::string_view keyName);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user