From 1b56dd572e01e2460c149ac6835db7bdf175b305 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Sun, 3 Oct 2010 08:45:34 +0000
Subject: Documentation related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2225 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/kernel/kernel.dox             |  9 +++------
 os/ports/GCC/ARMCMx/chcore.h     | 21 +++++++++++++++++++++
 os/ports/GCC/ARMCMx/chcore_v6m.h | 12 ------------
 os/ports/GCC/ARMCMx/chcore_v7m.h | 13 -------------
 os/ports/GCC/ARMCMx/port.dox     |  4 ++--
 5 files changed, 26 insertions(+), 33 deletions(-)

(limited to 'os')

diff --git a/os/kernel/kernel.dox b/os/kernel/kernel.dox
index 3ec1bfd8a..b946d49e9 100644
--- a/os/kernel/kernel.dox
+++ b/os/kernel/kernel.dox
@@ -35,6 +35,8 @@
 
 /**
  * @defgroup types Types
+ * @details The system types are defined into the port layer, please refer to
+ * the core port implementation section.
  * @ingroup kernel
  */
 
@@ -163,13 +165,8 @@
  * @ingroup kernel
  */
 
-/**
- * @defgroup core Port Templates
- * @ingroup kernel
- */
-
 /**
  * @defgroup internals Internals
  * @ingroup kernel
  */
- 
+ 
\ No newline at end of file
diff --git a/os/ports/GCC/ARMCMx/chcore.h b/os/ports/GCC/ARMCMx/chcore.h
index 4995013e5..3581a6dea 100644
--- a/os/ports/GCC/ARMCMx/chcore.h
+++ b/os/ports/GCC/ARMCMx/chcore.h
@@ -261,6 +261,27 @@ typedef uint32_t stkalign_t __attribute__ ((aligned (4)));
  */
 typedef void *regarm_t;
 
+#if defined(__DOXYGEN__)
+/**
+ * @brief   Interrupt saved context.
+ * @details This structure represents the stack frame saved during a
+ *          preemption-capable interrupt handler.
+ * @note    It is implemented to match the Cortex-Mx exception context.
+ */
+struct extctx {
+  /* Dummy definition, just for Doxygen.*/
+};
+
+/**
+ * @brief   System saved context.
+ * @details This structure represents the inner stack frame during a context
+ *          switching.
+ */
+struct intctx {
+  /* Dummy definition, just for Doxygen.*/
+};
+#endif
+
 #if !defined(__DOXYGEN__)
 /**
  * @brief   Platform dependent part of the @p Thread structure.
diff --git a/os/ports/GCC/ARMCMx/chcore_v6m.h b/os/ports/GCC/ARMCMx/chcore_v6m.h
index a4b0e582d..5f45f581d 100644
--- a/os/ports/GCC/ARMCMx/chcore_v6m.h
+++ b/os/ports/GCC/ARMCMx/chcore_v6m.h
@@ -47,11 +47,6 @@ struct cmxctx {
 };
 
 #if !defined(__DOXYGEN__)
-/**
- * @brief   Interrupt saved context.
- * @details This structure represents the stack frame saved during a
- *          preemption-capable interrupt handler.
- */
 struct extctx {
   regarm_t      xpsr;
   regarm_t      r12;
@@ -62,14 +57,7 @@ struct extctx {
   regarm_t      r3;
   regarm_t      pc;
 };
-#endif
 
-#if !defined(__DOXYGEN__)
-/**
- * @brief   System saved context.
- * @details This structure represents the inner stack frame during a context
- *          switching.
- */
 struct intctx {
   regarm_t      r8;
   regarm_t      r9;
diff --git a/os/ports/GCC/ARMCMx/chcore_v7m.h b/os/ports/GCC/ARMCMx/chcore_v7m.h
index 263e20e2d..2c9dd0952 100644
--- a/os/ports/GCC/ARMCMx/chcore_v7m.h
+++ b/os/ports/GCC/ARMCMx/chcore_v7m.h
@@ -33,12 +33,6 @@
 /*===========================================================================*/
 
 #if !defined(__DOXYGEN__)
-/**
- * @brief   Interrupt saved context.
- * @details This structure represents the stack frame saved during a
- *          preemption-capable interrupt handler.
- * @note    It is implemented to match the Cortex-Mx exception context.
- */
 struct extctx {
   regarm_t      r0;
   regarm_t      r1;
@@ -49,14 +43,7 @@ struct extctx {
   regarm_t      pc;
   regarm_t      xpsr;
 };
-#endif
 
-#if !defined(__DOXYGEN__)
-/**
- * @brief   System saved context.
- * @details This structure represents the inner stack frame during a context
- *          switching.
- */
 struct intctx {
   regarm_t      r4;
   regarm_t      r5;
diff --git a/os/ports/GCC/ARMCMx/port.dox b/os/ports/GCC/ARMCMx/port.dox
index f7a51dd2c..3556d3196 100644
--- a/os/ports/GCC/ARMCMx/port.dox
+++ b/os/ports/GCC/ARMCMx/port.dox
@@ -26,7 +26,7 @@
  * architectures.
  *
  * @section ARMCMx_STATES_A System logical states in ARMv6-M mode
- * The ChibiOS/RT logical system states are mapped as follow in the ARM
+ * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM
  * Cortex-M0 port:
  * - <b>Init</b>. This state is represented by the startup code and the
  *   initialization code before @p chSysInit() is executed. It has not a
@@ -60,7 +60,7 @@
  *   was running when @p chSysHalt() was invoked.
  *
  * @section ARMCMx_STATES_B System logical states in ARMv7-M mode
- * The ChibiOS/RT logical system states are mapped as follow in the ARM
+ * The ChibiOS/RT logical @ref system_states are mapped as follow in the ARM
  * Cortex-M3 port:
  * - <b>Init</b>. This state is represented by the startup code and the
  *   initialization code before @p chSysInit() is executed. It has not a
-- 
cgit v1.2.3