From 24a1aacca244481d7500baee5388f0f4087c4411 Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Thu, 24 Aug 2017 14:52:15 +0200 Subject: [PATCH] cpu/sam0: add missing doxygen group definition + cleanup --- cpu/sam0_common/doc.txt | 8 ++++++++ cpu/sam0_common/include/cpu_conf.h | 1 + cpu/sam0_common/include/periph_cpu_common.h | 1 + cpu/samd21/doc.txt | 9 +++++++++ cpu/samd21/include/periph_cpu.h | 1 + cpu/saml21/doc.txt | 9 +++++++++ cpu/saml21/include/periph_cpu.h | 1 + 7 files changed, 30 insertions(+) create mode 100644 cpu/sam0_common/doc.txt create mode 100644 cpu/samd21/doc.txt create mode 100644 cpu/saml21/doc.txt diff --git a/cpu/sam0_common/doc.txt b/cpu/sam0_common/doc.txt new file mode 100644 index 0000000000..f1bff6690f --- /dev/null +++ b/cpu/sam0_common/doc.txt @@ -0,0 +1,8 @@ +/** + * @defgroup cpu_sam0_common Atmel SAM0 common + * @ingroup cpu + * @brief Atmel SAM0 common + * + * This module contains all common code and definition to all Atmel SAM0 cpu + * families supported by RIOT: @ref cpu_samd21, @ref cpu_saml21. + */ \ No newline at end of file diff --git a/cpu/sam0_common/include/cpu_conf.h b/cpu/sam0_common/include/cpu_conf.h index ebcee250d9..e954eb139a 100644 --- a/cpu/sam0_common/include/cpu_conf.h +++ b/cpu/sam0_common/include/cpu_conf.h @@ -8,6 +8,7 @@ /** * @ingroup cpu_sam0_common + * @brief Implementation specific CPU configuration options * @{ * * @file diff --git a/cpu/sam0_common/include/periph_cpu_common.h b/cpu/sam0_common/include/periph_cpu_common.h index 461b1e2753..fbf6c6adad 100644 --- a/cpu/sam0_common/include/periph_cpu_common.h +++ b/cpu/sam0_common/include/periph_cpu_common.h @@ -8,6 +8,7 @@ /** * @ingroup cpu_sam0_common + * @brief Common CPU specific definitions for all SAMx21 based CPUs * @{ * * @file diff --git a/cpu/samd21/doc.txt b/cpu/samd21/doc.txt new file mode 100644 index 0000000000..a8453ff285 --- /dev/null +++ b/cpu/samd21/doc.txt @@ -0,0 +1,9 @@ +/** + * @defgroup cpu_samd21 Atmel SAMD21 + * @ingroup cpu + * @brief Atmel SAMD21 Cortex-M0 MCU specific implementation. + * + * This module contains Atmel SAMD21 specific code and definition. + * + * @see cpu_sam0_common + */ \ No newline at end of file diff --git a/cpu/samd21/include/periph_cpu.h b/cpu/samd21/include/periph_cpu.h index 3f5313ea1f..459e41f254 100644 --- a/cpu/samd21/include/periph_cpu.h +++ b/cpu/samd21/include/periph_cpu.h @@ -8,6 +8,7 @@ /** * @ingroup cpu_samd21 + * @brief CPU specific definitions for internal peripheral handling * @{ * * @file diff --git a/cpu/saml21/doc.txt b/cpu/saml21/doc.txt new file mode 100644 index 0000000000..49df961fc2 --- /dev/null +++ b/cpu/saml21/doc.txt @@ -0,0 +1,9 @@ +/** + * @defgroup cpu_saml21 Atmel SAML21 + * @ingroup cpu + * @brief Atmel SAML21 Cortex-M0 MCU specific implementation. + * + * This module contains Atmel SAML21 specific code and definition. + * + * @see cpu_sam0_common + */ \ No newline at end of file diff --git a/cpu/saml21/include/periph_cpu.h b/cpu/saml21/include/periph_cpu.h index 76bee3eb7e..600b1fae90 100644 --- a/cpu/saml21/include/periph_cpu.h +++ b/cpu/saml21/include/periph_cpu.h @@ -8,6 +8,7 @@ /** * @ingroup cpu_saml21 + * @brief CPU specific definitions for internal peripheral handling * @{ * * @file