stm32: doc: rtc: move to peripheral apis

Drop some dummy.c files, add some missing groupings and make sure all
specifics are included in the generated output.
This commit is contained in:
Karl Palsson 2019-05-22 00:16:40 +00:00
parent 0aef9c2ec6
commit f2a9980638
8 changed files with 10 additions and 137 deletions

View File

@ -1,4 +1,5 @@
/** @addtogroup rtc_file
/** @addtogroup rtc_file RTC peripheral API
@ingroup peripheral_apis
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>

View File

@ -36,7 +36,7 @@ TGT_CFLAGS += $(STANDARD_FLAGS)
ARFLAGS = rcs
OBJS = can.o flash.o rcc.o rtc.o comparator.o \
OBJS = can.o flash.o rcc.o comparator.o \
adc.o desig.o
OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o crc_v2.o \

View File

@ -1,31 +0,0 @@
/** @defgroup rtc_file RTC
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx RTC</b>
*
* @version 1.0.0
*
* @date 10 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/rtc.h>

View File

@ -1,6 +1,6 @@
/** @defgroup rtc_file RTC
/** @defgroup rtc_file RTC peripheral API
*
* @ingroup STM32F1xx
* @ingroup peripheral_apis
*
* @brief <b>libopencm3 STM32F1xx RTC</b>
*

View File

@ -1,31 +0,0 @@
/** @defgroup rtc_file RTC
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx RTC</b>
*
* @version 1.0.0
*
* @date 4 March 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/rtc.h>

View File

@ -1,38 +0,0 @@
/** @defgroup rtc_file RTC
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Real Time Clock</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/rtc.h>

View File

@ -1,6 +1,6 @@
/** @defgroup rtc_file RTC
/** @defgroup rtc_file
*
* @ingroup STM32F4xx
* @ingroup peripheral_apis
*
* @brief <b>libopencm3 STM32F4xx RTC</b>
*
@ -32,6 +32,7 @@
#include <libopencm3/cm3/nvic.h>
#include <libopencm3/stm32/rtc.h>
/**@{*/
/*---------------------------------------------------------------------------*/
/** @brief Enable the wakeup timer
@ -95,3 +96,5 @@ void rtc_disable_wakeup_timer_interrupt(void)
/* 3. Disable RTC wakeup timer event. */
RTC_CR &= ~RTC_CR_WUTIE;
}
/**@}*/

View File

@ -1,31 +0,0 @@
/** @defgroup rtc_file RTC
*
* @ingroup STM32L1xx
*
* @brief <b>libopencm3 STM32L1xx RTC</b>
*
* @version 1.0.0
*
* @date 4 March 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/rtc.h>