doc: efm32: burtc: tag properly for doxyen

includes a stub .c file until there are APIs defined.

include/libopencm3/efm32/common/burtc_common.h

@@ -1,3 +1,5 @@
+/** @addtogroup burtc_defines
+ */
 /*
  * This file is part of the libopencm3 project.
  *
@@ -17,12 +19,13 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBOPENCM3_EFM32_BURTC_H
+#pragma once
-#define LIBOPENCM3_EFM32_BURTC_H
 
 #include <libopencm3/efm32/memorymap.h>
 #include <libopencm3/cm3/common.h>
 
+/**@{*/
+
 #define BURTC_CTRL	MMIO32(BURTC_BASE + 0x000)
 #define BURTC_LPMODE	MMIO32(BURTC_BASE + 0x004)
 #define BURTC_CNT	MMIO32(BURTC_BASE + 0x008)
@@ -166,5 +169,5 @@
 #define BURTC_SYNCBUSY_COMP0		(1 << 1)
 #define BURTC_SYNCBUSY_LPMODE		(1 << 0)
 
-#endif
+/**@}*/
 

include/libopencm3/efm32/ezr32wg/burtc.h

@@ -1,3 +1,11 @@
+/** @defgroup burtc_defines BURTC Defines
+ *
+ * @brief <b>Defined Constants and Types for the Backup RTC</b>
+ *
+ * @ingroup EZR32WG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
 /*
  * This file is part of the libopencm3 project.
  *
@@ -17,9 +25,6 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBOPENCM3_EFM32_EZR32WG_BURTC_H
+#pragma once
-#define LIBOPENCM3_EFM32_EZR32WG_BURTC_H
 
 #include <libopencm3/efm32/common/burtc_common.h>
-
-#endif

include/libopencm3/efm32/lg/burtc.h

@@ -1,3 +1,11 @@
+/** @defgroup burtc_defines BURTC Defines
+ *
+ * @brief <b>Defined Constants and Types for the Backup RTC</b>
+ *
+ * @ingroup EFM32LG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
 /*
  * This file is part of the libopencm3 project.
  *
@@ -17,9 +25,6 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBOPENCM3_EFM32_LG_BURTC_H
+#pragma once
-#define LIBOPENCM3_EFM32_LG_BURTC_H
 
 #include <libopencm3/efm32/common/burtc_common.h>
-
-#endif

include/libopencm3/efm32/wg/burtc.h

@@ -1,3 +1,11 @@
+/** @defgroup burtc_defines BURTC Defines
+ *
+ * @brief <b>Defined Constants and Types for the Backup RTC</b>
+ *
+ * @ingroup EFM32WG_defines
+ *
+ * LGPL License Terms @ref lgpl_license
+ */
 /*
  * This file is part of the libopencm3 project.
  *
@@ -17,9 +25,6 @@
  * along with this library.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef LIBOPENCM3_EFM32_WG_BURTC_H
+#pragma once
-#define LIBOPENCM3_EFM32_WG_BURTC_H
 
 #include <libopencm3/efm32/common/burtc_common.h>
-
-#endif

lib/efm32/common/burtc_common.c

@@ -0,0 +1,15 @@
+/** @addtogroup burtc_file BURTC peripheral API
+ * @ingroup peripheral_apis
+ * @brief Backup RTC helper functions.
+ *
+ * <b>NO</b> helper functions exist. Only header definitions are available.
+ * Delete these lines if/when you add actual helper APIs.
+ * @copyright See @ref lgpl_license
+ */
+
+#include <libopencm3/efm32/burtc.h>
+
+/**@{*/
+
+/**@}*/
+

lib/efm32/ezr32wg/Makefile

@@ -39,6 +39,7 @@ ARFLAGS		= rcs
 
 OBJS += acmp_common.o
 OBJS += adc_common.o
+OBJS += burtc_common.o
 OBJS += cmu_common.o
 OBJS += dac_common.o
 OBJS += dma_common.o

lib/efm32/lg/Makefile

@@ -39,6 +39,7 @@ ARFLAGS		= rcs
 
 OBJS += acmp_common.o
 OBJS += adc_common.o
+OBJS += burtc_common.o
 OBJS += cmu_common.o
 OBJS += dac_common.o
 OBJS += dma_common.o

lib/efm32/wg/Makefile

@@ -39,6 +39,7 @@ ARFLAGS		= rcs
 
 OBJS += acmp_common.o
 OBJS += adc_common.o
+OBJS += burtc_common.o
 OBJS += cmu_common.o
 OBJS += dac_common.o
 OBJS += dma_common.o