From c5b0b9ebbc8fa2a8800a353602d935991a1da178 Mon Sep 17 00:00:00 2001 From: Edgar Bonet Date: Wed, 17 Jul 2019 17:56:53 +0200 Subject: [PATCH 1/2] Doxygen introduction to the available classes --- RTClib.cpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/RTClib.cpp b/RTClib.cpp index 6e3e4ac9..f7391f4c 100644 --- a/RTClib.cpp +++ b/RTClib.cpp @@ -15,6 +15,23 @@ please support Adafruit and open-source hardware by purchasing products from Adafruit! + @section classes Available classes + + This library provides the following classes: + + - Classes for manipulating dates, times and durations: + - DateTime represents a specific point in time; this is the data + type used for setting and reading the supported RTCs + - TimeSpan represents the length of a time interval + - Interfacing specific RTC chips: + - RTC_DS1307 + - RTC_DS3231 + - RTC_PCF8523 + - RTC emulated in software; do not expect much accuracy out of these: + - RTC_Millis is based on `millis()` + - RTC_Micros is based on `micros()`; its drift rate can be tuned by + the user + @section license License Original library by JeeLabs http://news.jeelabs.org/code/, released to the public domain. From 096df587181fbdcf5662ad069ea36b00fc36dc2e Mon Sep 17 00:00:00 2001 From: Edgar Bonet Date: Thu, 12 Sep 2019 21:23:38 +0200 Subject: [PATCH 2/2] Link to the Doxygen docs from README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ff9b17fa..df8891ea 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ This is a fork of JeeLab's fantastic real time clock library for Arduino. -For details on using this library with an RTC module like the DS1307, PCF8523, or DS3231, see the guide at: https://learn.adafruit.com/ds1307-real-time-clock-breakout-board-kit/overview +For a tutorial on using this library with an RTC module like the DS1307, PCF8523, or DS3231, see the guide at: https://learn.adafruit.com/ds1307-real-time-clock-breakout-board-kit/overview + +For the detailed API documentation, see https://adafruit.github.io/RTClib/html/index.html Works great with Adafruit RTC breakouts: