From 316c33a6a31247249c90437b129a30f7e882c6a1 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Mon, 5 Feb 2018 21:52:32 +0000 Subject: [PATCH] stm32: crc-v2: tweak doxygen output Make it group better and include labels --- include/libopencm3/stm32/common/crc_common_all.h | 14 +++++++------- include/libopencm3/stm32/common/crc_v2.h | 11 +++++++---- lib/stm32/common/crc_common_all.c | 2 +- lib/stm32/common/crc_v2.c | 2 +- 4 files changed, 16 insertions(+), 13 deletions(-) diff --git a/include/libopencm3/stm32/common/crc_common_all.h b/include/libopencm3/stm32/common/crc_common_all.h index 4d16c203..f883590c 100644 --- a/include/libopencm3/stm32/common/crc_common_all.h +++ b/include/libopencm3/stm32/common/crc_common_all.h @@ -43,13 +43,13 @@ specific memorymap.h header before including this header file.*/ /* Register definitions */ /*****************************************************************************/ -/* Data register (CRC_DR) */ +/** CRC_DR Data register */ #define CRC_DR MMIO32(CRC_BASE + 0x00) -/* Independent data register (CRC_IDR) */ +/** CRC_IDR Independent data register */ #define CRC_IDR MMIO32(CRC_BASE + 0x04) -/* Control register (CRC_CR) */ +/** CRC_CR Control register */ #define CRC_CR MMIO32(CRC_BASE + 0x08) /*****************************************************************************/ @@ -66,12 +66,12 @@ specific memorymap.h header before including this header file.*/ /* Bits [7:0]: General-purpose 8-bit data register bits */ -/* --- CRC_CR values ------------------------------------------------------- */ -/* Bits [31:1]: Reserved */ - -/* RESET bit */ +/** @defgroup crc_cr_values CRC_CR values + @{*/ +/** CRC_CR_RESET reset the CRC peripheral */ #define CRC_CR_RESET (1 << 0) +/**@}*/ /*****************************************************************************/ /* API definitions */ diff --git a/include/libopencm3/stm32/common/crc_v2.h b/include/libopencm3/stm32/common/crc_v2.h index 1c60b38d..850dc252 100644 --- a/include/libopencm3/stm32/common/crc_v2.h +++ b/include/libopencm3/stm32/common/crc_v2.h @@ -45,20 +45,22 @@ /* Register definitions */ /*****************************************************************************/ -/* Data register (CRC_DR) */ +/** CRC_DR Data register 8bit wide access */ #define CRC_DR8 MMIO8(CRC_BASE + 0x00) +/** CRC_DR Data register 16bit wide access */ #define CRC_DR16 MMIO16(CRC_BASE + 0x00) -/* Initial CRC Value */ +/** CRC_INIT Initial CRC Value */ #define CRC_INIT MMIO32(CRC_BASE + 0x10) -/* CRC Polynomial */ +/** CRC_POL CRC Polynomial */ #define CRC_POL MMIO32(CRC_BASE + 0x14) /*****************************************************************************/ /* Register values */ /*****************************************************************************/ - +/** @addtogroup crc_cr_values CRC_CR values + @{*/ #define CRC_CR_REV_OUT (1 << 7) #define CRC_CR_REV_IN_SHIFT 5 @@ -77,6 +79,7 @@ /* Default polynomial */ #define CRC_POL_DEFAULT 0x04C11DB7 +/**@}*/ /*****************************************************************************/ /* API definitions */ diff --git a/lib/stm32/common/crc_common_all.c b/lib/stm32/common/crc_common_all.c index 5794c8f9..36b9a9b5 100644 --- a/lib/stm32/common/crc_common_all.c +++ b/lib/stm32/common/crc_common_all.c @@ -1,4 +1,4 @@ -/** @addtogroup crc_file +/** @addtogroup crc_file CRC @author @htmlonly © @endhtmlonly 2012 Karl Palsson diff --git a/lib/stm32/common/crc_v2.c b/lib/stm32/common/crc_v2.c index 5f25fe40..e7be7164 100644 --- a/lib/stm32/common/crc_v2.c +++ b/lib/stm32/common/crc_v2.c @@ -1,4 +1,4 @@ -/** @addtogroup crc_defines +/** @addtogroup crc_file CRC @author @htmlonly © @endhtmlonly 2016 Cem Basoglu