From a9ce3290b5fabc893a66d778e13ff35cf649f525 Mon Sep 17 00:00:00 2001 From: Jade Date: Wed, 21 Aug 2024 22:55:03 +0800 Subject: [PATCH] Fix Doxygen warnings for C++ code (#6608) --- cscore/src/main/native/include/cscore_raw.h | 3 +-- docs/build.gradle | 4 ++-- .../native/include/networktables/Topic.inc.jinja | 16 ++++++++-------- .../include/networktables/BooleanArrayTopic.inc | 16 ++++++++-------- .../include/networktables/BooleanTopic.inc | 12 ++++++------ .../include/networktables/DoubleArrayTopic.inc | 16 ++++++++-------- .../native/include/networktables/DoubleTopic.inc | 12 ++++++------ .../include/networktables/FloatArrayTopic.inc | 16 ++++++++-------- .../native/include/networktables/FloatTopic.inc | 12 ++++++------ .../include/networktables/IntegerArrayTopic.inc | 16 ++++++++-------- .../include/networktables/IntegerTopic.inc | 12 ++++++------ .../native/include/networktables/RawTopic.inc | 16 ++++++++-------- .../include/networktables/StringArrayTopic.inc | 12 ++++++------ .../native/include/networktables/StringTopic.inc | 16 ++++++++-------- .../native/include/frc2/command/button/Trigger.h | 1 + wpimath/src/main/native/include/frc/fmt/Eigen.h | 5 +++++ wpiutil/src/main/native/include/wpi/jni_util.h | 3 +++ 17 files changed, 98 insertions(+), 90 deletions(-) diff --git a/cscore/src/main/native/include/cscore_raw.h b/cscore/src/main/native/include/cscore_raw.h index e610683563..6333bca655 100644 --- a/cscore/src/main/native/include/cscore_raw.h +++ b/cscore/src/main/native/include/cscore_raw.h @@ -199,11 +199,10 @@ inline uint64_t RawSink::GrabFrameNoTimeout(wpi::RawFrame& image) const { m_status = 0; return GrabSinkFrame(m_handle, image, &m_status); } +/** @} */ } // namespace cs -/** @} */ - #endif #endif // CSCORE_CSCORE_RAW_H_ diff --git a/docs/build.gradle b/docs/build.gradle index 0e0eca4776..cccaf36ef0 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -185,9 +185,9 @@ doxygen { strip_from_inc_path cppIncludeRoots as String[] strip_from_path cppIncludeRoots as String[] use_mathjax true - warnings false + warnings true warn_if_incomplete_doc true - warn_if_undocumented false + warn_if_undocumented true warn_no_paramdoc true enable_preprocessing true diff --git a/ntcore/src/generate/main/native/include/networktables/Topic.inc.jinja b/ntcore/src/generate/main/native/include/networktables/Topic.inc.jinja index ce343d99fe..7a5bc7693b 100644 --- a/ntcore/src/generate/main/native/include/networktables/Topic.inc.jinja +++ b/ntcore/src/generate/main/native/include/networktables/Topic.inc.jinja @@ -15,7 +15,7 @@ namespace nt { inline {{ TypeName }}Subscriber::{{ TypeName }}Subscriber( - NT_Subscriber handle, {{ cpp.ParamType }} defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{{ '{' }}{{ cpp.DefaultValueCopy|default('defaultValue') }}} {} @@ -24,7 +24,7 @@ inline {{ cpp.ValueType }} {{ TypeName }}Subscriber::Get() const { } inline {{ cpp.ValueType }} {{ TypeName }}Subscriber::Get( - {{ cpp.ParamType }} defaultValue) const { + ParamType defaultValue) const { return ::nt::Get{{ TypeName }}(m_subHandle, defaultValue); } {% if cpp.SmallRetType and cpp.SmallElemType %} @@ -32,7 +32,7 @@ inline {{ cpp.SmallRetType }} {{ TypeName }}Subscriber::Get(wpi::SmallVectorImpl return Get(buf, m_defaultValue); } -inline {{ cpp.SmallRetType }} {{ TypeName }}Subscriber::Get(wpi::SmallVectorImpl<{{ cpp.SmallElemType }}>& buf, {{ cpp.ParamType }} defaultValue) const { +inline {{ cpp.SmallRetType }} {{ TypeName }}Subscriber::Get(wpi::SmallVectorImpl<{{ cpp.SmallElemType }}>& buf, ParamType defaultValue) const { return nt::Get{{ TypeName }}(m_subHandle, buf, defaultValue); } {% endif %} @@ -41,7 +41,7 @@ inline Timestamped{{ TypeName }} {{ TypeName }}Subscriber::GetAtomic() const { } inline Timestamped{{ TypeName }} {{ TypeName }}Subscriber::GetAtomic( - {{ cpp.ParamType }} defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomic{{ TypeName }}(m_subHandle, defaultValue); } {% if cpp.SmallRetType and cpp.SmallElemType %} @@ -49,7 +49,7 @@ inline Timestamped{{ TypeName }}View {{ TypeName }}Subscriber::GetAtomic(wpi::Sm return GetAtomic(buf, m_defaultValue); } -inline Timestamped{{ TypeName }}View {{ TypeName }}Subscriber::GetAtomic(wpi::SmallVectorImpl<{{ cpp.SmallElemType }}>& buf, {{ cpp.ParamType }} defaultValue) const { +inline Timestamped{{ TypeName }}View {{ TypeName }}Subscriber::GetAtomic(wpi::SmallVectorImpl<{{ cpp.SmallElemType }}>& buf, ParamType defaultValue) const { return nt::GetAtomic{{ TypeName }}(m_subHandle, buf, defaultValue); } {% endif %} @@ -65,12 +65,12 @@ inline {{ TypeName }}Topic {{ TypeName }}Subscriber::GetTopic() const { inline {{ TypeName }}Publisher::{{ TypeName }}Publisher(NT_Publisher handle) : Publisher{handle} {} -inline void {{ TypeName }}Publisher::Set({{ cpp.ParamType }} value, +inline void {{ TypeName }}Publisher::Set(ParamType value, int64_t time) { ::nt::Set{{ TypeName }}(m_pubHandle, value, time); } -inline void {{ TypeName }}Publisher::SetDefault({{ cpp.ParamType }} value) { +inline void {{ TypeName }}Publisher::SetDefault(ParamType value) { ::nt::SetDefault{{ TypeName }}(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline {{ TypeName }}Topic {{ TypeName }}Publisher::GetTopic() const { } inline {{ TypeName }}Entry::{{ TypeName }}Entry( - NT_Entry handle, {{ cpp.ParamType }} defaultValue) + NT_Entry handle, ParamType defaultValue) : {{ TypeName }}Subscriber{handle, defaultValue}, {{ TypeName }}Publisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/BooleanArrayTopic.inc b/ntcore/src/generated/main/native/include/networktables/BooleanArrayTopic.inc index 404ec7e23d..53bd5e4d23 100644 --- a/ntcore/src/generated/main/native/include/networktables/BooleanArrayTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/BooleanArrayTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline BooleanArraySubscriber::BooleanArraySubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector BooleanArraySubscriber::Get() const { } inline std::vector BooleanArraySubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetBooleanArray(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::span BooleanArraySubscriber::Get(wpi::SmallVectorImpl& buf return Get(buf, m_defaultValue); } -inline std::span BooleanArraySubscriber::Get(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline std::span BooleanArraySubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetBooleanArray(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedBooleanArray BooleanArraySubscriber::GetAtomic() const { } inline TimestampedBooleanArray BooleanArraySubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicBooleanArray(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedBooleanArrayView BooleanArraySubscriber::GetAtomic(wpi::SmallV return GetAtomic(buf, m_defaultValue); } -inline TimestampedBooleanArrayView BooleanArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline TimestampedBooleanArrayView BooleanArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicBooleanArray(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline BooleanArrayTopic BooleanArraySubscriber::GetTopic() const { inline BooleanArrayPublisher::BooleanArrayPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void BooleanArrayPublisher::Set(std::span value, +inline void BooleanArrayPublisher::Set(ParamType value, int64_t time) { ::nt::SetBooleanArray(m_pubHandle, value, time); } -inline void BooleanArrayPublisher::SetDefault(std::span value) { +inline void BooleanArrayPublisher::SetDefault(ParamType value) { ::nt::SetDefaultBooleanArray(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline BooleanArrayTopic BooleanArrayPublisher::GetTopic() const { } inline BooleanArrayEntry::BooleanArrayEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : BooleanArraySubscriber{handle, defaultValue}, BooleanArrayPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/BooleanTopic.inc b/ntcore/src/generated/main/native/include/networktables/BooleanTopic.inc index 2a4d7e61ce..5b7d099957 100644 --- a/ntcore/src/generated/main/native/include/networktables/BooleanTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/BooleanTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline BooleanSubscriber::BooleanSubscriber( - NT_Subscriber handle, bool defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue} {} @@ -24,7 +24,7 @@ inline bool BooleanSubscriber::Get() const { } inline bool BooleanSubscriber::Get( - bool defaultValue) const { + ParamType defaultValue) const { return ::nt::GetBoolean(m_subHandle, defaultValue); } @@ -33,7 +33,7 @@ inline TimestampedBoolean BooleanSubscriber::GetAtomic() const { } inline TimestampedBoolean BooleanSubscriber::GetAtomic( - bool defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicBoolean(m_subHandle, defaultValue); } @@ -49,12 +49,12 @@ inline BooleanTopic BooleanSubscriber::GetTopic() const { inline BooleanPublisher::BooleanPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void BooleanPublisher::Set(bool value, +inline void BooleanPublisher::Set(ParamType value, int64_t time) { ::nt::SetBoolean(m_pubHandle, value, time); } -inline void BooleanPublisher::SetDefault(bool value) { +inline void BooleanPublisher::SetDefault(ParamType value) { ::nt::SetDefaultBoolean(m_pubHandle, value); } @@ -63,7 +63,7 @@ inline BooleanTopic BooleanPublisher::GetTopic() const { } inline BooleanEntry::BooleanEntry( - NT_Entry handle, bool defaultValue) + NT_Entry handle, ParamType defaultValue) : BooleanSubscriber{handle, defaultValue}, BooleanPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/DoubleArrayTopic.inc b/ntcore/src/generated/main/native/include/networktables/DoubleArrayTopic.inc index bab8dd0080..f6cb74219a 100644 --- a/ntcore/src/generated/main/native/include/networktables/DoubleArrayTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/DoubleArrayTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline DoubleArraySubscriber::DoubleArraySubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector DoubleArraySubscriber::Get() const { } inline std::vector DoubleArraySubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetDoubleArray(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::span DoubleArraySubscriber::Get(wpi::SmallVectorImpl return Get(buf, m_defaultValue); } -inline std::span DoubleArraySubscriber::Get(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline std::span DoubleArraySubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetDoubleArray(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedDoubleArray DoubleArraySubscriber::GetAtomic() const { } inline TimestampedDoubleArray DoubleArraySubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicDoubleArray(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedDoubleArrayView DoubleArraySubscriber::GetAtomic(wpi::SmallVec return GetAtomic(buf, m_defaultValue); } -inline TimestampedDoubleArrayView DoubleArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline TimestampedDoubleArrayView DoubleArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicDoubleArray(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline DoubleArrayTopic DoubleArraySubscriber::GetTopic() const { inline DoubleArrayPublisher::DoubleArrayPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void DoubleArrayPublisher::Set(std::span value, +inline void DoubleArrayPublisher::Set(ParamType value, int64_t time) { ::nt::SetDoubleArray(m_pubHandle, value, time); } -inline void DoubleArrayPublisher::SetDefault(std::span value) { +inline void DoubleArrayPublisher::SetDefault(ParamType value) { ::nt::SetDefaultDoubleArray(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline DoubleArrayTopic DoubleArrayPublisher::GetTopic() const { } inline DoubleArrayEntry::DoubleArrayEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : DoubleArraySubscriber{handle, defaultValue}, DoubleArrayPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/DoubleTopic.inc b/ntcore/src/generated/main/native/include/networktables/DoubleTopic.inc index 49b1c4c8b5..1ca4ec4b93 100644 --- a/ntcore/src/generated/main/native/include/networktables/DoubleTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/DoubleTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline DoubleSubscriber::DoubleSubscriber( - NT_Subscriber handle, double defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue} {} @@ -24,7 +24,7 @@ inline double DoubleSubscriber::Get() const { } inline double DoubleSubscriber::Get( - double defaultValue) const { + ParamType defaultValue) const { return ::nt::GetDouble(m_subHandle, defaultValue); } @@ -33,7 +33,7 @@ inline TimestampedDouble DoubleSubscriber::GetAtomic() const { } inline TimestampedDouble DoubleSubscriber::GetAtomic( - double defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicDouble(m_subHandle, defaultValue); } @@ -49,12 +49,12 @@ inline DoubleTopic DoubleSubscriber::GetTopic() const { inline DoublePublisher::DoublePublisher(NT_Publisher handle) : Publisher{handle} {} -inline void DoublePublisher::Set(double value, +inline void DoublePublisher::Set(ParamType value, int64_t time) { ::nt::SetDouble(m_pubHandle, value, time); } -inline void DoublePublisher::SetDefault(double value) { +inline void DoublePublisher::SetDefault(ParamType value) { ::nt::SetDefaultDouble(m_pubHandle, value); } @@ -63,7 +63,7 @@ inline DoubleTopic DoublePublisher::GetTopic() const { } inline DoubleEntry::DoubleEntry( - NT_Entry handle, double defaultValue) + NT_Entry handle, ParamType defaultValue) : DoubleSubscriber{handle, defaultValue}, DoublePublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/FloatArrayTopic.inc b/ntcore/src/generated/main/native/include/networktables/FloatArrayTopic.inc index 93570765e1..3eeb112d6d 100644 --- a/ntcore/src/generated/main/native/include/networktables/FloatArrayTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/FloatArrayTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline FloatArraySubscriber::FloatArraySubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector FloatArraySubscriber::Get() const { } inline std::vector FloatArraySubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetFloatArray(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::span FloatArraySubscriber::Get(wpi::SmallVectorImpl& b return Get(buf, m_defaultValue); } -inline std::span FloatArraySubscriber::Get(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline std::span FloatArraySubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetFloatArray(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedFloatArray FloatArraySubscriber::GetAtomic() const { } inline TimestampedFloatArray FloatArraySubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicFloatArray(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedFloatArrayView FloatArraySubscriber::GetAtomic(wpi::SmallVecto return GetAtomic(buf, m_defaultValue); } -inline TimestampedFloatArrayView FloatArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline TimestampedFloatArrayView FloatArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicFloatArray(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline FloatArrayTopic FloatArraySubscriber::GetTopic() const { inline FloatArrayPublisher::FloatArrayPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void FloatArrayPublisher::Set(std::span value, +inline void FloatArrayPublisher::Set(ParamType value, int64_t time) { ::nt::SetFloatArray(m_pubHandle, value, time); } -inline void FloatArrayPublisher::SetDefault(std::span value) { +inline void FloatArrayPublisher::SetDefault(ParamType value) { ::nt::SetDefaultFloatArray(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline FloatArrayTopic FloatArrayPublisher::GetTopic() const { } inline FloatArrayEntry::FloatArrayEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : FloatArraySubscriber{handle, defaultValue}, FloatArrayPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/FloatTopic.inc b/ntcore/src/generated/main/native/include/networktables/FloatTopic.inc index 9df0f793ed..3f8f448486 100644 --- a/ntcore/src/generated/main/native/include/networktables/FloatTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/FloatTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline FloatSubscriber::FloatSubscriber( - NT_Subscriber handle, float defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue} {} @@ -24,7 +24,7 @@ inline float FloatSubscriber::Get() const { } inline float FloatSubscriber::Get( - float defaultValue) const { + ParamType defaultValue) const { return ::nt::GetFloat(m_subHandle, defaultValue); } @@ -33,7 +33,7 @@ inline TimestampedFloat FloatSubscriber::GetAtomic() const { } inline TimestampedFloat FloatSubscriber::GetAtomic( - float defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicFloat(m_subHandle, defaultValue); } @@ -49,12 +49,12 @@ inline FloatTopic FloatSubscriber::GetTopic() const { inline FloatPublisher::FloatPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void FloatPublisher::Set(float value, +inline void FloatPublisher::Set(ParamType value, int64_t time) { ::nt::SetFloat(m_pubHandle, value, time); } -inline void FloatPublisher::SetDefault(float value) { +inline void FloatPublisher::SetDefault(ParamType value) { ::nt::SetDefaultFloat(m_pubHandle, value); } @@ -63,7 +63,7 @@ inline FloatTopic FloatPublisher::GetTopic() const { } inline FloatEntry::FloatEntry( - NT_Entry handle, float defaultValue) + NT_Entry handle, ParamType defaultValue) : FloatSubscriber{handle, defaultValue}, FloatPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/IntegerArrayTopic.inc b/ntcore/src/generated/main/native/include/networktables/IntegerArrayTopic.inc index ba3d00d1d2..f4156a4943 100644 --- a/ntcore/src/generated/main/native/include/networktables/IntegerArrayTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/IntegerArrayTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline IntegerArraySubscriber::IntegerArraySubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector IntegerArraySubscriber::Get() const { } inline std::vector IntegerArraySubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetIntegerArray(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::span IntegerArraySubscriber::Get(wpi::SmallVectorImpl IntegerArraySubscriber::Get(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline std::span IntegerArraySubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetIntegerArray(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedIntegerArray IntegerArraySubscriber::GetAtomic() const { } inline TimestampedIntegerArray IntegerArraySubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicIntegerArray(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedIntegerArrayView IntegerArraySubscriber::GetAtomic(wpi::SmallV return GetAtomic(buf, m_defaultValue); } -inline TimestampedIntegerArrayView IntegerArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline TimestampedIntegerArrayView IntegerArraySubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicIntegerArray(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline IntegerArrayTopic IntegerArraySubscriber::GetTopic() const { inline IntegerArrayPublisher::IntegerArrayPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void IntegerArrayPublisher::Set(std::span value, +inline void IntegerArrayPublisher::Set(ParamType value, int64_t time) { ::nt::SetIntegerArray(m_pubHandle, value, time); } -inline void IntegerArrayPublisher::SetDefault(std::span value) { +inline void IntegerArrayPublisher::SetDefault(ParamType value) { ::nt::SetDefaultIntegerArray(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline IntegerArrayTopic IntegerArrayPublisher::GetTopic() const { } inline IntegerArrayEntry::IntegerArrayEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : IntegerArraySubscriber{handle, defaultValue}, IntegerArrayPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/IntegerTopic.inc b/ntcore/src/generated/main/native/include/networktables/IntegerTopic.inc index 2ca31e53e1..2d58adc163 100644 --- a/ntcore/src/generated/main/native/include/networktables/IntegerTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/IntegerTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline IntegerSubscriber::IntegerSubscriber( - NT_Subscriber handle, int64_t defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue} {} @@ -24,7 +24,7 @@ inline int64_t IntegerSubscriber::Get() const { } inline int64_t IntegerSubscriber::Get( - int64_t defaultValue) const { + ParamType defaultValue) const { return ::nt::GetInteger(m_subHandle, defaultValue); } @@ -33,7 +33,7 @@ inline TimestampedInteger IntegerSubscriber::GetAtomic() const { } inline TimestampedInteger IntegerSubscriber::GetAtomic( - int64_t defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicInteger(m_subHandle, defaultValue); } @@ -49,12 +49,12 @@ inline IntegerTopic IntegerSubscriber::GetTopic() const { inline IntegerPublisher::IntegerPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void IntegerPublisher::Set(int64_t value, +inline void IntegerPublisher::Set(ParamType value, int64_t time) { ::nt::SetInteger(m_pubHandle, value, time); } -inline void IntegerPublisher::SetDefault(int64_t value) { +inline void IntegerPublisher::SetDefault(ParamType value) { ::nt::SetDefaultInteger(m_pubHandle, value); } @@ -63,7 +63,7 @@ inline IntegerTopic IntegerPublisher::GetTopic() const { } inline IntegerEntry::IntegerEntry( - NT_Entry handle, int64_t defaultValue) + NT_Entry handle, ParamType defaultValue) : IntegerSubscriber{handle, defaultValue}, IntegerPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/RawTopic.inc b/ntcore/src/generated/main/native/include/networktables/RawTopic.inc index b31ebcb1f7..e0c7e61abc 100644 --- a/ntcore/src/generated/main/native/include/networktables/RawTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/RawTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline RawSubscriber::RawSubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector RawSubscriber::Get() const { } inline std::vector RawSubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetRaw(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::span RawSubscriber::Get(wpi::SmallVectorImpl& buf) return Get(buf, m_defaultValue); } -inline std::span RawSubscriber::Get(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline std::span RawSubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetRaw(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedRaw RawSubscriber::GetAtomic() const { } inline TimestampedRaw RawSubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicRaw(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedRawView RawSubscriber::GetAtomic(wpi::SmallVectorImpl return GetAtomic(buf, m_defaultValue); } -inline TimestampedRawView RawSubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::span defaultValue) const { +inline TimestampedRawView RawSubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicRaw(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline RawTopic RawSubscriber::GetTopic() const { inline RawPublisher::RawPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void RawPublisher::Set(std::span value, +inline void RawPublisher::Set(ParamType value, int64_t time) { ::nt::SetRaw(m_pubHandle, value, time); } -inline void RawPublisher::SetDefault(std::span value) { +inline void RawPublisher::SetDefault(ParamType value) { ::nt::SetDefaultRaw(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline RawTopic RawPublisher::GetTopic() const { } inline RawEntry::RawEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : RawSubscriber{handle, defaultValue}, RawPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/StringArrayTopic.inc b/ntcore/src/generated/main/native/include/networktables/StringArrayTopic.inc index f003ff00c5..d6b20a2ca6 100644 --- a/ntcore/src/generated/main/native/include/networktables/StringArrayTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/StringArrayTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline StringArraySubscriber::StringArraySubscriber( - NT_Subscriber handle, std::span defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue.begin(), defaultValue.end()} {} @@ -24,7 +24,7 @@ inline std::vector StringArraySubscriber::Get() const { } inline std::vector StringArraySubscriber::Get( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetStringArray(m_subHandle, defaultValue); } @@ -33,7 +33,7 @@ inline TimestampedStringArray StringArraySubscriber::GetAtomic() const { } inline TimestampedStringArray StringArraySubscriber::GetAtomic( - std::span defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicStringArray(m_subHandle, defaultValue); } @@ -49,12 +49,12 @@ inline StringArrayTopic StringArraySubscriber::GetTopic() const { inline StringArrayPublisher::StringArrayPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void StringArrayPublisher::Set(std::span value, +inline void StringArrayPublisher::Set(ParamType value, int64_t time) { ::nt::SetStringArray(m_pubHandle, value, time); } -inline void StringArrayPublisher::SetDefault(std::span value) { +inline void StringArrayPublisher::SetDefault(ParamType value) { ::nt::SetDefaultStringArray(m_pubHandle, value); } @@ -63,7 +63,7 @@ inline StringArrayTopic StringArrayPublisher::GetTopic() const { } inline StringArrayEntry::StringArrayEntry( - NT_Entry handle, std::span defaultValue) + NT_Entry handle, ParamType defaultValue) : StringArraySubscriber{handle, defaultValue}, StringArrayPublisher{handle} {} diff --git a/ntcore/src/generated/main/native/include/networktables/StringTopic.inc b/ntcore/src/generated/main/native/include/networktables/StringTopic.inc index a1934e4cfd..39428852af 100644 --- a/ntcore/src/generated/main/native/include/networktables/StringTopic.inc +++ b/ntcore/src/generated/main/native/include/networktables/StringTopic.inc @@ -15,7 +15,7 @@ namespace nt { inline StringSubscriber::StringSubscriber( - NT_Subscriber handle, std::string_view defaultValue) + NT_Subscriber handle, ParamType defaultValue) : Subscriber{handle}, m_defaultValue{defaultValue} {} @@ -24,7 +24,7 @@ inline std::string StringSubscriber::Get() const { } inline std::string StringSubscriber::Get( - std::string_view defaultValue) const { + ParamType defaultValue) const { return ::nt::GetString(m_subHandle, defaultValue); } @@ -32,7 +32,7 @@ inline std::string_view StringSubscriber::Get(wpi::SmallVectorImpl& buf) c return Get(buf, m_defaultValue); } -inline std::string_view StringSubscriber::Get(wpi::SmallVectorImpl& buf, std::string_view defaultValue) const { +inline std::string_view StringSubscriber::Get(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetString(m_subHandle, buf, defaultValue); } @@ -41,7 +41,7 @@ inline TimestampedString StringSubscriber::GetAtomic() const { } inline TimestampedString StringSubscriber::GetAtomic( - std::string_view defaultValue) const { + ParamType defaultValue) const { return ::nt::GetAtomicString(m_subHandle, defaultValue); } @@ -49,7 +49,7 @@ inline TimestampedStringView StringSubscriber::GetAtomic(wpi::SmallVectorImpl& buf, std::string_view defaultValue) const { +inline TimestampedStringView StringSubscriber::GetAtomic(wpi::SmallVectorImpl& buf, ParamType defaultValue) const { return nt::GetAtomicString(m_subHandle, buf, defaultValue); } @@ -65,12 +65,12 @@ inline StringTopic StringSubscriber::GetTopic() const { inline StringPublisher::StringPublisher(NT_Publisher handle) : Publisher{handle} {} -inline void StringPublisher::Set(std::string_view value, +inline void StringPublisher::Set(ParamType value, int64_t time) { ::nt::SetString(m_pubHandle, value, time); } -inline void StringPublisher::SetDefault(std::string_view value) { +inline void StringPublisher::SetDefault(ParamType value) { ::nt::SetDefaultString(m_pubHandle, value); } @@ -79,7 +79,7 @@ inline StringTopic StringPublisher::GetTopic() const { } inline StringEntry::StringEntry( - NT_Entry handle, std::string_view defaultValue) + NT_Entry handle, ParamType defaultValue) : StringSubscriber{handle, defaultValue}, StringPublisher{handle} {} diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h b/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h index 2ef93b9c1b..a238263133 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/button/Trigger.h @@ -285,6 +285,7 @@ class Trigger { /** * Returns the current state of this trigger. + * * @return A bool representing the current state of the trigger. */ bool Get() const; diff --git a/wpimath/src/main/native/include/frc/fmt/Eigen.h b/wpimath/src/main/native/include/frc/fmt/Eigen.h index 4f608553c3..487027c66c 100644 --- a/wpimath/src/main/native/include/frc/fmt/Eigen.h +++ b/wpimath/src/main/native/include/frc/fmt/Eigen.h @@ -10,6 +10,10 @@ #include #include +// FIXME: Doxygen gives internal inconsistency errors: + +//! @cond Doxygen_Suppress + /** * Formatter for classes derived from Eigen::DenseBase or * Eigen::SparseCompressedBase. @@ -44,3 +48,4 @@ struct fmt::formatter { private: fmt::formatter m_underlying; }; +//! @endcond diff --git a/wpiutil/src/main/native/include/wpi/jni_util.h b/wpiutil/src/main/native/include/wpi/jni_util.h index f341842391..4e451a6367 100644 --- a/wpiutil/src/main/native/include/wpi/jni_util.h +++ b/wpiutil/src/main/native/include/wpi/jni_util.h @@ -399,12 +399,15 @@ class JSpanBase { return {reinterpret_cast(arr.data()), arr.size()}; } + // FIXME doxygen gives error parsing initializer list + //! @cond Doxygen_Suppress private: bool m_valid; JNIEnv* m_env; jarray_type m_jarr = nullptr; size_t m_size; std::remove_cv_t* m_elements; + //! @endcond }; } // namespace detail