stm32: rtc: doxygenize existing docs

Might as well show the information we have!
This commit is contained in:
Karl Palsson
2020-12-10 22:00:03 +00:00
parent e07f23bb70
commit 992a4d3753

View File

@@ -1,8 +1,14 @@
/** @addtogroup rtc_defines /** @addtogroup rtc_defines
* @author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au> *
* @brief This covers the "version 2" RTC peripheral.
*/ *
* This is completely different
* to the v1 RTC periph on the F1 series devices. It has BCD counters, with
* automatic leapyear corrections and daylight savings support.
* This peripheral is used on the F0, F2, F3, F4 and L1 devices, though some
* only support a subset.
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
@@ -22,14 +28,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
/*
* This covers the "version 2" RTC peripheral. This is completely different
* to the v1 RTC periph on the F1 series devices. It has BCD counters, with
* automatic leapyear corrections and daylight savings support.
* This peripheral is used on the F0, F2, F3, F4 and L1 devices, though some
* only support a subset.
*/
/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA RTC.H /* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA RTC.H
The order of header inclusion is important. rtc.h includes the device The order of header inclusion is important. rtc.h includes the device
specific memorymap.h header before including this header file.*/ specific memorymap.h header before including this header file.*/