From 8435287300e5ca9af9f889c529e7b1fa019c42fb Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Wed, 2 Dec 2020 00:04:44 +0000 Subject: [PATCH] stm32: dma: doxygen fixups Use a single @defgroup for the "root" of a common heirarchy, and only addtogroup for additions. This prevents an alphabetically "first" entry from being used as the documentation for the entire group. --- lib/stm32/common/dma_common_csel.c | 5 +---- lib/stm32/common/dma_common_f24.c | 3 ++- lib/stm32/common/dma_common_l1f013.c | 3 ++- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/stm32/common/dma_common_csel.c b/lib/stm32/common/dma_common_csel.c index 4cf1fca9..0dbce57b 100644 --- a/lib/stm32/common/dma_common_csel.c +++ b/lib/stm32/common/dma_common_csel.c @@ -1,7 +1,4 @@ -/** @addtogroup dma_file DMA peripheral API -@ingroup peripheral_apis - -LGPL License Terms @ref lgpl_license +/** @addtogroup dma_file */ /* * This file is part of the libopencm3 project. diff --git a/lib/stm32/common/dma_common_f24.c b/lib/stm32/common/dma_common_f24.c index 2c61b548..ac583316 100644 --- a/lib/stm32/common/dma_common_f24.c +++ b/lib/stm32/common/dma_common_f24.c @@ -1,5 +1,6 @@ -/** @addtogroup dma_file DMA peripheral API +/** @defgroup dma_file DMA peripheral API @ingroup peripheral_apis +@brief DMA library for the multi stream controller found in f2/f4/f7 parts. @author @htmlonly © @endhtmlonly 2012 Ken Sarkies diff --git a/lib/stm32/common/dma_common_l1f013.c b/lib/stm32/common/dma_common_l1f013.c index 2f9190a4..439d2bfa 100644 --- a/lib/stm32/common/dma_common_l1f013.c +++ b/lib/stm32/common/dma_common_l1f013.c @@ -1,5 +1,6 @@ -/** @addtogroup dma_file DMA peripheral API +/** @defgroup dma_file DMA peripheral API @ingroup peripheral_apis +@brief DMA library for the multi channel controller found in F0/1/3 & L/G parts. @author @htmlonly © @endhtmlonly 2010 Thomas Otto