From 70d356f4978012f7b428ffc9eec1c4c9c2b58201 Mon Sep 17 00:00:00 2001
From: Edgar Bonet <linux@edgar-bonet.org>
Date: Sat, 31 Jul 2021 18:26:39 +0200
Subject: [PATCH] Add missing Doxygen documentation

Pull request #231 added a new member to each RTC class, and a new
parameter to each begin() method. Add the corresponding Doxygen
documentation.
---
 src/RTClib.cpp | 4 ++++
 src/RTClib.h   | 8 ++++----
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/RTClib.cpp b/src/RTClib.cpp
index 121abeb..02a703f 100644
--- a/src/RTClib.cpp
+++ b/src/RTClib.cpp
@@ -808,6 +808,7 @@ static uint8_t bin2bcd(uint8_t val) { return val + 6 * (val / 10); }
 /**************************************************************************/
 /*!
     @brief  Start I2C for the DS1307 and test succesful connection
+    @param  wireInstance pointer to the I2C bus
     @return True if Wire can find DS1307 or false otherwise.
 */
 /**************************************************************************/
@@ -1053,6 +1054,7 @@ DateTime RTC_Micros::now() {
 /**************************************************************************/
 /*!
     @brief  Start I2C for the PCF8523 and test succesful connection
+    @param  wireInstance pointer to the I2C bus
     @return True if Wire can find PCF8523 or false otherwise.
 */
 /**************************************************************************/
@@ -1402,6 +1404,7 @@ void RTC_PCF8523::calibrate(Pcf8523OffsetMode mode, int8_t offset) {
 /**************************************************************************/
 /*!
     @brief  Start I2C for the PCF8563 and test succesful connection
+    @param  wireInstance pointer to the I2C bus
     @return True if Wire can find PCF8563 or false otherwise.
 */
 /**************************************************************************/
@@ -1564,6 +1567,7 @@ static uint8_t dowToDS3231(uint8_t d) { return d == 0 ? 7 : d; }
 /**************************************************************************/
 /*!
     @brief  Start I2C for the DS3231 and test succesful connection
+    @param  wireInstance pointer to the I2C bus
     @return True if Wire can find DS3231 or false otherwise.
 */
 /**************************************************************************/
diff --git a/src/RTClib.h b/src/RTClib.h
index e1f51c0..36ade88 100644
--- a/src/RTClib.h
+++ b/src/RTClib.h
@@ -287,7 +287,7 @@ public:
   void writenvram(uint8_t address, uint8_t *buf, uint8_t size);
 
 protected:
-  TwoWire *RTCWireBus;
+  TwoWire *RTCWireBus; ///< I2C bus connected to the RTC
 };
 
 /** DS3231 SQW pin mode settings */
@@ -347,7 +347,7 @@ public:
   float getTemperature(); // in Celsius degree
 
 protected:
-  TwoWire *RTCWireBus;
+  TwoWire *RTCWireBus; ///< I2C bus connected to the RTC
 };
 
 /** PCF8523 INT/SQW pin mode settings */
@@ -418,7 +418,7 @@ public:
   void calibrate(Pcf8523OffsetMode mode, int8_t offset);
 
 protected:
-  TwoWire *RTCWireBus;
+  TwoWire *RTCWireBus; ///< I2C bus connected to the RTC
 };
 
 /** PCF8563 CLKOUT pin mode settings */
@@ -449,7 +449,7 @@ public:
   void writeSqwPinMode(Pcf8563SqwPinMode mode);
 
 protected:
-  TwoWire *RTCWireBus;
+  TwoWire *RTCWireBus; ///< I2C bus connected to the RTC
 };
 
 /**************************************************************************/