From d970738c5651b4779ff1d6c7edbc3ee9ce9049b5 Mon Sep 17 00:00:00 2001
From: Toma Radu <radustoma@yahoo.com>
Date: Tue, 17 Dec 2013 15:55:22 -0600
Subject: arm_lm3s69xx: improve doxygen

Add doxygen to the header files in the arm/lm3s69xx/include directory.
---
 c/src/lib/libbsp/arm/lm3s69xx/include/bsp.h      | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/io.h       | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/irq.h      | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/lm3s69xx.h | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/ssi.h      | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/syscon.h   | 16 ++++++++++++++++
 c/src/lib/libbsp/arm/lm3s69xx/include/uart.h     | 16 ++++++++++++++++
 7 files changed, 112 insertions(+)

(limited to 'c/src/lib')

diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/bsp.h b/c/src/lib/libbsp/arm/lm3s69xx/include/bsp.h
index a385cb423f..c633441446 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/bsp.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/bsp.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief Global BSP Definitions
+ */
+
 /*
  * Copyright (c) 2011-2012 Sebastian Huber.  All rights reserved.
  *
@@ -36,3 +44,11 @@
 #endif /* ASM */
 
 #endif /* LIBBSP_ARM_LM3S69XX_BSP_H */
+
+/**
+ * @defgroup arm_lm3s69xx LM3S69XX Support
+ *
+ * @ingroup bsp_arm
+ *
+ * @brief LM3S69XX Support Package
+ */
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/io.h b/c/src/lib/libbsp/arm/lm3s69xx/include/io.h
index dc698fa9ee..03878bbbfe 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/io.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/io.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ * 
+ * @ingroup lm3s69xx_io
+ *
+ * @brief IO definitions.
+ */
+
 /*
  * Copyright © 2013 Eugeniy Meshcheryakov <eugen@debian.org>
  *
@@ -11,6 +19,14 @@
 #include <bspopts.h>
 #include <stdbool.h>
 
+/**
+ * @defgroup lm3s69xx_io IO Support
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief IO support.
+ */
+
 typedef enum {
   LM3S69XX_GPIO_DIRECTION_INPUT,
   LM3S69XX_GPIO_DIRECTION_OUTPUT
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/irq.h b/c/src/lib/libbsp/arm/lm3s69xx/include/irq.h
index 8ab9bcd272..3b504143ab 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/irq.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/irq.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm3s69xx_interrupt
+ *
+ * @brief Interrupt definitions.
+ */
+
 /*
  * Copyright © 2013 Eugeniy Meshcheryakov <eugen@debian.org>
  *
@@ -24,6 +32,14 @@
 #include <rtems/irq-extension.h>
 #include <bspopts.h>
 
+/**
+ * @defgroup lm3s69xx_interrupt Interrupt Support
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief Interrupt support.
+ */
+
 #endif /* ASM */
 
 #define LM3S69XX_IRQ_GPIO_PORT_A 0
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/lm3s69xx.h b/c/src/lib/libbsp/arm/lm3s69xx/include/lm3s69xx.h
index 2b38d936cb..c136d17499 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/lm3s69xx.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/lm3s69xx.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm3s69xx_reg
+ *
+ * @brief Register definitions.
+ */
+
 /*
  * Copyright © 2013 Eugeniy Meshcheryakov <eugen@debian.org>
  *
@@ -19,6 +27,14 @@
 #include <bspopts.h>
 #include <bsp/utility.h>
 
+/**
+ * @defgroup lm3s69xx_reg Register Definitions
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief Register Definitions 
+ */
+
 #define LM3S69XX_SYSCON_BASE 0x400fe000
 
 #define LM3S69XX_UART_0_BASE 0x4000c000
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/ssi.h b/c/src/lib/libbsp/arm/lm3s69xx/include/ssi.h
index 1089769d7d..854e6bcfdc 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/ssi.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/ssi.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm3s69xx_ssi 
+ *
+ * @brief SSI support.
+ */
+
 /*
  * Copyright © 2013 Eugeniy Meshcheryakov <eugen@debian.org>
  *
@@ -10,6 +18,14 @@
 #include <rtems/libi2c.h>
 #include <bspopts.h>
 
+/**
+ * @defgroup lm3s69xx_ssi SSI Support
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief SSI Support
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/syscon.h b/c/src/lib/libbsp/arm/lm3s69xx/include/syscon.h
index 78af4a757e..85a078124b 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/syscon.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/syscon.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm3s69xx_syscon
+ *
+ * @brief Syscon support.
+ */
+
 /*
  * Copyright © 2013 Eugeniy Meshcheryakov <eugen@debian.org>
  *
@@ -9,6 +17,14 @@
 #define LIBBSP_ARM_LM3S69XX_SYSCON_H
 #include <stdbool.h>
 
+/**
+ * @defgroup lm3s69xx_syscon Syscon Support
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief Syscon Support
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/c/src/lib/libbsp/arm/lm3s69xx/include/uart.h b/c/src/lib/libbsp/arm/lm3s69xx/include/uart.h
index bc7f921ce0..c695ad2e88 100644
--- a/c/src/lib/libbsp/arm/lm3s69xx/include/uart.h
+++ b/c/src/lib/libbsp/arm/lm3s69xx/include/uart.h
@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @ingroup lm3s69xx_uart
+ *
+ * brief UART support.
+ */
+
 /*
  * Copyright (c) 2011 Sebastian Huber.  All rights reserved.
  *
@@ -17,6 +25,14 @@
 
 #include <libchip/serial.h>
 
+/**
+ * defgroup lm3s69xx_uart UART Support
+ *
+ * @ingroup arm_lm3s69xx
+ *
+ * @brief UART support.
+ */
+
 #ifdef __cplusplus
 extern "C" {
 #endif /* __cplusplus */
-- 
cgit v1.2.3