From 72914369e801b4ecc388914bb8c9fe66a8a37cfb Mon Sep 17 00:00:00 2001
From: George Oikonomou <g.oikonomou@bristol.ac.uk>
Date: Sat, 14 Feb 2015 02:13:21 +0100
Subject: [PATCH] Re-structure CC2538 doxygen module hierarchy

---
 cpu/cc2538/cpu.h                 | 15 +++++++++++++--
 cpu/cc2538/spi-arch.h            | 12 ++++--------
 examples/cc2538dk/cc2538-demo.c  |  4 ++--
 platform/cc2538dk/contiki-conf.h |  2 +-
 platform/cc2538dk/contiki-main.c |  4 ++--
 platform/cc2538dk/dev/board.h    |  3 ++-
 platform/cc2538dk/startup-gcc.c  |  2 +-
 7 files changed, 25 insertions(+), 17 deletions(-)

diff --git a/cpu/cc2538/cpu.h b/cpu/cc2538/cpu.h
index e8cd7e282..51ffa9075 100644
--- a/cpu/cc2538/cpu.h
+++ b/cpu/cc2538/cpu.h
@@ -29,12 +29,21 @@
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \addtogroup cc2538
+ * \addtogroup platform
+ * @{
+ *
+ * \defgroup cc2538-platforms TI cc2538-powered platforms
+ *
+ * Documentation for all platforms powered by the TI cc2538 System-on-Chip
+ * @{
+ *
+ * \defgroup cc2538 The TI cc2538 System-on-Chip
+ * CPU-Specific functionality - available to all cc2538-based platforms
  * @{
  *
  * \defgroup cc2538-cpu cc2538 CPU
  *
- * cc2538 CPU-specific functions for the cc2538 core
+ * CPU-specific functions for the cc2538 core
  * @{
  *
  * \file
@@ -60,6 +69,8 @@ unsigned long cpu_cpsie(void);
 #endif /* CPU_H_ */
 
 /**
+ * @}
+ * @}
  * @}
  * @}
  */
diff --git a/cpu/cc2538/spi-arch.h b/cpu/cc2538/spi-arch.h
index 53d7fe78d..46d8d3bf4 100644
--- a/cpu/cc2538/spi-arch.h
+++ b/cpu/cc2538/spi-arch.h
@@ -27,16 +27,13 @@
  * SUCH DAMAGE.
  */
 /**
- * \addtogroup cc2538
+ * \addtogroup cc2538-spi
  * @{
  *
- * Implementation of the low-level SPI primitives such as waiting for the TX
- * FIFO to be ready, inserting into the TX FIFO, etc.
- * @{
- */
-/**
  * \file
- * Header file for the cc2538 SPI commands
+ * Header file for the cc2538 SPI driver, including macros for the
+ * implementation of the low-level SPI primitives such as waiting for the TX
+ * FIFO to be ready, inserting into the TX FIFO, etc.
  */
 #ifndef SPI_ARCH_H_
 #define SPI_ARCH_H_
@@ -121,6 +118,5 @@ void spi_set_mode(uint32_t frame_format, uint32_t clock_polarity,
 #endif /* SPI_ARCH_H_ */
 
 /**
- * @}
  * @}
  */
diff --git a/examples/cc2538dk/cc2538-demo.c b/examples/cc2538dk/cc2538-demo.c
index d7fa056f2..9210968c2 100644
--- a/examples/cc2538dk/cc2538-demo.c
+++ b/examples/cc2538dk/cc2538-demo.c
@@ -29,10 +29,10 @@
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \addtogroup cc2538
+ * \addtogroup cc2538-platforms
  * @{
  *
- * \defgroup cc2538-examples cc2538dk Example Projects
+ * \defgroup cc2538-examples cc2538 Example Projects
  * @{
  *
  * \defgroup cc2538-demo cc2538dk Demo Project
diff --git a/platform/cc2538dk/contiki-conf.h b/platform/cc2538dk/contiki-conf.h
index 84d78d9a1..354f042db 100644
--- a/platform/cc2538dk/contiki-conf.h
+++ b/platform/cc2538dk/contiki-conf.h
@@ -1,5 +1,5 @@
 /**
- * \addtogroup cc2538
+ * \addtogroup cc2538dk
  * @{
  *
  * \file
diff --git a/platform/cc2538dk/contiki-main.c b/platform/cc2538dk/contiki-main.c
index c66faed33..414d2aebb 100644
--- a/platform/cc2538dk/contiki-main.c
+++ b/platform/cc2538dk/contiki-main.c
@@ -29,10 +29,10 @@
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \addtogroup platform
+ * \addtogroup cc2538-platforms
  * @{
  *
- * \defgroup cc2538 The cc2538 Development Kit platform
+ * \defgroup cc2538dk The cc2538 Development Kit platform
  *
  * The cc2538DK is the new platform by Texas Instruments, based on the
  * cc2530 SoC with an ARM Cortex-M3 core.
diff --git a/platform/cc2538dk/dev/board.h b/platform/cc2538dk/dev/board.h
index c32941cd2..d5514839d 100644
--- a/platform/cc2538dk/dev/board.h
+++ b/platform/cc2538dk/dev/board.h
@@ -28,7 +28,8 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  * OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-/** \addtogroup cc2538
+/** 
+ * \addtogroup cc2538dk
  * @{
  *
  * \defgroup cc2538-smartrf SmartRF06EB Peripherals
diff --git a/platform/cc2538dk/startup-gcc.c b/platform/cc2538dk/startup-gcc.c
index 8647fd638..ce3db6dde 100644
--- a/platform/cc2538dk/startup-gcc.c
+++ b/platform/cc2538dk/startup-gcc.c
@@ -30,7 +30,7 @@
  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \addtogroup cc2538
+ * \addtogroup cc2538dk
  * @{
  *
  * \file