From 992a4d375315e2f375cce8e6a202a690591d873d Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Thu, 10 Dec 2020 22:00:03 +0000 Subject: [PATCH] stm32: rtc: doxygenize existing docs Might as well show the information we have! --- .../stm32/common/rtc_common_l1f024.h | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/include/libopencm3/stm32/common/rtc_common_l1f024.h b/include/libopencm3/stm32/common/rtc_common_l1f024.h index 66cce5f7..4ae116b8 100644 --- a/include/libopencm3/stm32/common/rtc_common_l1f024.h +++ b/include/libopencm3/stm32/common/rtc_common_l1f024.h @@ -1,8 +1,14 @@ /** @addtogroup rtc_defines - -@author @htmlonly © @endhtmlonly 2012 Karl Palsson - -*/ + * @author @htmlonly © @endhtmlonly 2012 Karl Palsson + * + * @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. * @@ -22,14 +28,6 @@ * along with this library. If not, see . */ -/* - * 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 The order of header inclusion is important. rtc.h includes the device specific memorymap.h header before including this header file.*/