[rtems commit] libbsp/arm: add doxygen to arm shared headers

Gedare Bloom gedare at rtems.org
Mon Dec 23 02:00:04 UTC 2013 

Module:    rtems
Branch:    master
Commit:    b7212b9f1f6813c3fbe549ea6cd8559a59f584ea
Changeset: http://git.rtems.org/rtems/commit/?id=b7212b9f1f6813c3fbe549ea6cd8559a59f584ea

Author:    Szkocsovszki Zsolt <zsoltisharkboy at gmail.com>
Date:      Sun Dec 22 21:07:02 2013 -0500

libbsp/arm: add doxygen to arm shared headers

---

 .../libbsp/arm/shared/armv7m/include/armv7m-irq.h  |    8 ++++++++
 c/src/lib/libbsp/arm/shared/comm/uart.h            |    7 +++++++
 .../libbsp/arm/shared/include/arm-a9mpcore-irq.h   |    8 ++++++++
 .../libbsp/arm/shared/include/arm-a9mpcore-regs.h  |    8 ++++++++
 .../libbsp/arm/shared/include/arm-a9mpcore-start.h |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h  |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-gic.h      |   16 ++++++++++++++++
 .../lib/libbsp/arm/shared/include/arm-pl011-regs.h |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-pl011.h    |    8 ++++++++
 .../lib/libbsp/arm/shared/include/arm-pl050-regs.h |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-pl050.h    |    8 ++++++++
 c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h |    8 ++++++++
 .../lib/libbsp/arm/shared/include/arm-pl111-regs.h |    8 ++++++++
 15 files changed, 127 insertions(+), 0 deletions(-)

diff --git a/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h b/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h
index 80af772..6213ed1 100644
--- a/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h
+++ b/c/src/lib/libbsp/arm/shared/armv7m/include/armv7m-irq.h
@@ -1,3 +1,11 @@
+/**
+  *  @file
+  *
+  *  @ingroup arm_shared
+  *
+  *  @brief ARMV7M Support
+  */
+
 /*
  * Copyright (c) 2012 Sebastian Huber.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/comm/uart.h b/c/src/lib/libbsp/arm/shared/comm/uart.h
index 4e6e102..1370f7a 100644
--- a/c/src/lib/libbsp/arm/shared/comm/uart.h
+++ b/c/src/lib/libbsp/arm/shared/comm/uart.h
@@ -1,3 +1,10 @@
+/**
+  *  @file
+  *
+  *  @ingroup arm_comm
+  *
+  *  @brief UART Support
+  */
 
 /*
  * This software is Copyright (C) 1998 by T.sqware - all rights limited
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h
index 0361d4f..be164df 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-irq.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM_A9MPCORE_IRQ Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h
index dc7fd75..86bdcb2 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-regs.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM_A9MPCORE_REGS Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h
index 3c41d4e..a62dcda 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-a9mpcore-start.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief A9MPCORE_START Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h
index 5c152a1..7d5fc8f 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-irq.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_gic
+ *
+ *  @brief ARM GIC IRQ
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h
index 1c1608a..c76aa19 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-regs.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_gic
+ *
+ *  @brief ARM GIC Register definitions
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h b/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h
index 45e6c5d..0ca7fcf 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-gic-tm27.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_gic
+ *
+ *  @brief ARM GIC TM27 Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-gic.h b/c/src/lib/libbsp/arm/shared/include/arm-gic.h
index a336bfa..61e21be 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-gic.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-gic.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_gic
+ *
+ *  @brief ARM GIC Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
@@ -23,6 +31,14 @@
 extern "C" {
 #endif /* __cplusplus */
 
+/**
+ *  @defgroup arm_gic ARM GIC
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM_GIC Support Package
+ */
+
 #define GIC_ID_TO_ONE_BIT_REG_INDEX(id) ((id) >> 5)
 #define GIC_ID_TO_ONE_BIT_REG_BIT(id) (1U << ((id) & 0x1fU))
 
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h
index 0b0bd1f..876f029 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl011-regs.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM PL011 Register definitions
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl011.h b/c/src/lib/libbsp/arm/shared/include/arm-pl011.h
index 537e382..8db7552 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl011.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl011.h
@@ -1,3 +1,11 @@
+/**
+  *  @file
+  *
+  *  @ingroup arm_shared
+  *
+  *  @brief ARM PL011 Support Package
+  */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h
index 93c99b6..32e927c 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl050-regs.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM PL050 Register Definitions
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl050.h b/c/src/lib/libbsp/arm/shared/include/arm-pl050.h
index 4bb6b79..0233bcd 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl050.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl050.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM PL050 Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h b/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h
index 0503c6c..4e44893 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl111-fb.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM PL111 FB Support
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *
diff --git a/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h b/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h
index 02ea3f4..e30d46a 100644
--- a/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h
+++ b/c/src/lib/libbsp/arm/shared/include/arm-pl111-regs.h
@@ -1,3 +1,11 @@
+/**
+ *  @file
+ *
+ *  @ingroup arm_shared
+ *
+ *  @brief ARM PL111 Register definitions
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *

More information about the vc mailing list