From 776f44942eb6c13b75b67e44a6c60d41a2b66860 Mon Sep 17 00:00:00 2001 From: ladyada Date: Tue, 15 Sep 2026 16:37:14 -0400 Subject: [PATCH] Document deleted NMEA copy operations for CI Name and document the disabled copy parameters so the CI Doxygen check can validate both declarations. Co-authored-by: Limor Fried --- src/Adafruit_NMEA.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Adafruit_NMEA.h b/src/Adafruit_NMEA.h index 5af008f..2fc471b 100644 --- a/src/Adafruit_NMEA.h +++ b/src/Adafruit_NMEA.h @@ -70,8 +70,12 @@ typedef struct { class Adafruit_NMEA { public: Adafruit_NMEA(char *firstBuffer, char *secondBuffer, size_t capacity); - Adafruit_NMEA(const Adafruit_NMEA &) = delete; - Adafruit_NMEA &operator=(const Adafruit_NMEA &) = delete; + /// @brief Copying is disabled to prevent sharing writable receive buffers. + /// @param other Receiver that cannot be copied. + Adafruit_NMEA(const Adafruit_NMEA &other) = delete; + /// @brief Assignment is disabled to prevent sharing writable receive buffers. + /// @param other Receiver that cannot be assigned. + Adafruit_NMEA &operator=(const Adafruit_NMEA &other) = delete; void reset(); nmea_frame_status_t feed(uint8_t byte, uint32_t receivedAtMs); nmea_sentence_t lastSentence() const;