Files
allwpilib/upstream_utils/sleipnir_patches/0009-Suppress-Doxygen-warning-false-positives.patch
2026-05-27 21:26:42 -07:00

32 lines
1.3 KiB
Diff
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Tyler Veness <calcmogul@gmail.com>
Date: Sun, 29 Mar 2026 16:09:30 -0700
Subject: [PATCH 09/10] Suppress Doxygen warning false positives
---
.../optimization/solver/util/feasibility_restoration.hpp | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/sleipnir/optimization/solver/util/feasibility_restoration.hpp b/include/sleipnir/optimization/solver/util/feasibility_restoration.hpp
index 6324ddcf2d24a0cd5367420af4330e1c59b58004..ed128e5a583d51bc963f03f6b88c0a15e6440545 100644
--- a/include/sleipnir/optimization/solver/util/feasibility_restoration.hpp
+++ b/include/sleipnir/optimization/solver/util/feasibility_restoration.hpp
@@ -96,6 +96,8 @@ compute_p_n(const Eigen::Vector<Scalar, Eigen::Dynamic>& c, Scalar ρ,
return {std::move(p), std::move(n)};
}
+// @cond Suppress Doxygen
+
/// Finds the iterate that minimizes the constraint violation while not
/// deviating too far from the starting point. This is a fallback procedure when
/// the normal Sequential Quadratic Programming method fails to converge to a
@@ -624,6 +626,8 @@ ExitStatus feasibility_restoration(
}
}
+// @endcond
+
} // namespace slp
#include "sleipnir/optimization/solver/interior_point.hpp"