From b9cf3a7072d08f2da1428d6563a3939a182e1a17 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Thu, 15 Feb 2018 00:03:13 +0000 Subject: [PATCH] doc: convert CRC periphal to common naming Previously scattered about under "crc_file" and under "STM32blah->CRC" Deletes empty doxygen marker files, and uses groups instead. --- lib/stm32/common/crc_common_all.c | 3 ++- lib/stm32/common/crc_v2.c | 3 ++- lib/stm32/f0/Makefile | 2 +- lib/stm32/f0/crc.c | 31 ----------------------------- lib/stm32/f1/crc.c | 31 ----------------------------- lib/stm32/f2/crc.c | 33 ------------------------------- lib/stm32/f4/crc.c | 33 ------------------------------- lib/stm32/l1/Makefile | 2 +- lib/stm32/l1/crc.c | 33 ------------------------------- 9 files changed, 6 insertions(+), 165 deletions(-) delete mode 100644 lib/stm32/f0/crc.c delete mode 100644 lib/stm32/f1/crc.c delete mode 100644 lib/stm32/f2/crc.c delete mode 100644 lib/stm32/f4/crc.c delete mode 100644 lib/stm32/l1/crc.c diff --git a/lib/stm32/common/crc_common_all.c b/lib/stm32/common/crc_common_all.c index 36b9a9b5..06bb6d4f 100644 --- a/lib/stm32/common/crc_common_all.c +++ b/lib/stm32/common/crc_common_all.c @@ -1,4 +1,5 @@ -/** @addtogroup crc_file CRC +/** @addtogroup crc_file CRC peripheral API +@ingroup peripheral_apis @author @htmlonly © @endhtmlonly 2012 Karl Palsson diff --git a/lib/stm32/common/crc_v2.c b/lib/stm32/common/crc_v2.c index e7be7164..b98f29e0 100644 --- a/lib/stm32/common/crc_v2.c +++ b/lib/stm32/common/crc_v2.c @@ -1,4 +1,5 @@ -/** @addtogroup crc_file CRC +/** @addtogroup crc_file CRC peripheral API +@ingroup peripheral_apis @author @htmlonly © @endhtmlonly 2016 Cem Basoglu diff --git a/lib/stm32/f0/Makefile b/lib/stm32/f0/Makefile index 61ef2ecc..cd2b37e6 100644 --- a/lib/stm32/f0/Makefile +++ b/lib/stm32/f0/Makefile @@ -36,7 +36,7 @@ TGT_CFLAGS += $(STANDARD_FLAGS) ARFLAGS = rcs -OBJS = can.o flash.o rcc.o dma.o rtc.o comparator.o crc.o \ +OBJS = can.o flash.o rcc.o dma.o rtc.o comparator.o \ dac.o iwdg.o pwr.o gpio.o timer.o adc.o desig.o OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o crc_v2.o \ diff --git a/lib/stm32/f0/crc.c b/lib/stm32/f0/crc.c deleted file mode 100644 index 2519b22f..00000000 --- a/lib/stm32/f0/crc.c +++ /dev/null @@ -1,31 +0,0 @@ -/** @defgroup crc_file CRC - * - * @ingroup STM32F0xx - * - * @brief libopencm3 STM32F0xx CRC - * - * @version 1.0.0 - * - * @date 11 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 . - */ - -#include diff --git a/lib/stm32/f1/crc.c b/lib/stm32/f1/crc.c deleted file mode 100644 index 027052dc..00000000 --- a/lib/stm32/f1/crc.c +++ /dev/null @@ -1,31 +0,0 @@ -/** @defgroup crc_file CRC - -@ingroup STM32F1xx - -@brief libopencm3 STM32F1xx CRC - -@version 1.0.0 - -@date 15 October 2012 - -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 . - */ - -#include diff --git a/lib/stm32/f2/crc.c b/lib/stm32/f2/crc.c deleted file mode 100644 index c5ae5d38..00000000 --- a/lib/stm32/f2/crc.c +++ /dev/null @@ -1,33 +0,0 @@ -/** @defgroup crc_file CRC - -@ingroup STM32F2xx - -@brief libopencm3 STM32F2xx CRC - -@version 1.0.0 - -@date 15 October 2012 - -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 . - */ - -#include - - diff --git a/lib/stm32/f4/crc.c b/lib/stm32/f4/crc.c deleted file mode 100644 index 6bc9456b..00000000 --- a/lib/stm32/f4/crc.c +++ /dev/null @@ -1,33 +0,0 @@ -/** @defgroup crc_file CRC - -@ingroup STM32F4xx - -@brief libopencm3 STM32F4xx CRC - -@version 1.0.0 - -@date 15 October 2012 - -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 . - */ - -#include - - diff --git a/lib/stm32/l1/Makefile b/lib/stm32/l1/Makefile index 2f40546e..30eb43c2 100644 --- a/lib/stm32/l1/Makefile +++ b/lib/stm32/l1/Makefile @@ -35,7 +35,7 @@ TGT_CFLAGS += $(DEBUG_FLAGS) TGT_CFLAGS += $(STANDARD_FLAGS) # ARFLAGS = rcsv ARFLAGS = rcs -OBJS = crc.o desig.o flash.o rcc.o dma.o lcd.o +OBJS = desig.o flash.o rcc.o dma.o lcd.o OBJS += crc_common_all.o dac_common_all.o OBJS += dma_common_l1f013.o OBJS += flash_common_l01.o diff --git a/lib/stm32/l1/crc.c b/lib/stm32/l1/crc.c deleted file mode 100644 index 8a71c899..00000000 --- a/lib/stm32/l1/crc.c +++ /dev/null @@ -1,33 +0,0 @@ -/** @defgroup crc_file CRC - -@ingroup STM32L1xx - -@brief libopencm3 STM32L1xx CRC - -@version 1.0.0 - -@date 15 October 2012 - -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 . - */ - -#include - -