Michel2/RTClib
1
0
Fork 0
mirror of https://github.com/adafruit/RTClib.git synced 2026-07-27 19:56:05 +00:00
Code Issues Releases Activity

Add missing Doxygen documentation

Browse Source 
Pull request #231 added a new member to each RTC class, and a new
parameter to each begin() method. Add the corresponding Doxygen
documentation.
This commit is contained in:
Edgar Bonet
2021-07-31 18:28:18 +02:00
parent 33707a6817
commit 70d356f497
2 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/RTClib.cpp
+4
View File
@@ -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.
*/
/**************************************************************************/
src/RTClib.h
+4 -4
View File
@@ -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
};
/**************************************************************************/