From aa4e61fab20d8fee3dc77c91562985102a3ff1fc Mon Sep 17 00:00:00 2001
From: Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
Date: Fri, 16 May 2014 16:16:20 +0200
Subject: [PATCH] documentation: clean up doxygen mess after cortex
fixes #1190
---
cpu/cortexm_common/doc.txt | 40 +++++++++++++++++++++++++++
cpu/cortexm_common/include/core_cm3.h | 2 +-
cpu/sam3x8e/doc.txt | 10 +++++++
cpu/sam3x8e/include/component/doc.txt | 5 ++++
cpu/sam3x8e/include/cpu-conf.h | 3 --
cpu/sam3x8e/include/sam3x8e.h | 2 +-
6 files changed, 57 insertions(+), 5 deletions(-)
create mode 100644 cpu/cortexm_common/doc.txt
create mode 100644 cpu/sam3x8e/doc.txt
create mode 100644 cpu/sam3x8e/include/component/doc.txt
diff --git a/cpu/cortexm_common/doc.txt b/cpu/cortexm_common/doc.txt
new file mode 100644
index 0000000000..e54053e201
--- /dev/null
+++ b/cpu/cortexm_common/doc.txt
@@ -0,0 +1,40 @@
+/**
+ * @defgroup cortexm Cortex-M
+ * @brief ARM Cortex-M specific code
+ * @ingroup cpu
+ */
+
+/**
+ * @defgroup CMSIS_Core_FunctionInterface
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_core_register
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_glob_defs
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_MISRA_Exceptions
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_core_definitions
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_SIMD_intrinsics
+ * @ingroup cortexm
+ */
+
+/**
+ * @defgroup CMSIS_Core_InstructionInterface
+ * @ingroup cortexm
+ */
diff --git a/cpu/cortexm_common/include/core_cm3.h b/cpu/cortexm_common/include/core_cm3.h
index 185688f14d..dd7c666e1b 100644
--- a/cpu/cortexm_common/include/core_cm3.h
+++ b/cpu/cortexm_common/include/core_cm3.h
@@ -32,7 +32,7 @@
#define __CORE_CM3_H_GENERIC
-/** \mainpage CMSIS Cortex-M3
+/** CMSIS Cortex-M3
This documentation describes the CMSIS Cortex-M Core Peripheral Access Layer.
It consists of:
diff --git a/cpu/sam3x8e/doc.txt b/cpu/sam3x8e/doc.txt
new file mode 100644
index 0000000000..30a96ca12c
--- /dev/null
+++ b/cpu/sam3x8e/doc.txt
@@ -0,0 +1,10 @@
+/**
+ * @defgroup cpu_sam3x8e Atmel SAM3X8E
+ * @ingroup cpu
+ * @brief Implementation of Atmel's SAM3X8E Cortex-M3 MCU
+ */
+
+/**
+ * @defgroup cpu_sam3x8e_definitions Atmel SAM3X8E Definitions
+ * @ingroup cpu_sam3x8e
+ */
diff --git a/cpu/sam3x8e/include/component/doc.txt b/cpu/sam3x8e/include/component/doc.txt
new file mode 100644
index 0000000000..ba2bd5edf2
--- /dev/null
+++ b/cpu/sam3x8e/include/component/doc.txt
@@ -0,0 +1,5 @@
+/**
+ * @defgroup cpu_sam3x8e_components SAM3XA Components
+ * @brief SAM3XA Components
+ * @ingroup cpu_sam3x8e
+ */
diff --git a/cpu/sam3x8e/include/cpu-conf.h b/cpu/sam3x8e/include/cpu-conf.h
index 40f2d5c7e5..f2929c5b1f 100644
--- a/cpu/sam3x8e/include/cpu-conf.h
+++ b/cpu/sam3x8e/include/cpu-conf.h
@@ -7,9 +7,6 @@
*/
/**
- * @defgroup cpu_sam3x8e Atmel SAM3X8E
- * @ingroup cpu
- * @brief Implementation of Atmel's SAM3X8E Cortex-M3 MCU
* @{
*
* @file cpu-conf.h
diff --git a/cpu/sam3x8e/include/sam3x8e.h b/cpu/sam3x8e/include/sam3x8e.h
index 4abf35f0ed..b1810fb963 100644
--- a/cpu/sam3x8e/include/sam3x8e.h
+++ b/cpu/sam3x8e/include/sam3x8e.h
@@ -30,7 +30,7 @@
#ifndef _SAM3X8E_
#define _SAM3X8E_
-/** \addtogroup SAM3X8E_definitions SAM3X8E definitions
+/** \addtogroup cpu_sam3x8e_definitions SAM3X8E definitions
This file defines all structures and symbols for SAM3X8E:
- registers and bitfields
- peripheral base address
--
GitLab