diff options
author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-02 11:04:23 +0000 |
---|---|---|
committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-02 11:04:23 +0000 |
commit | 9a42d5914405143eabaf1c38891c29aafcd6a77d (patch) | |
tree | aa4997b45e11f00b6ef87ef9c9a0a7dd41c60b47 | |
parent | 55848af13c5077a42ef71b15ab98e003ed709948 (diff) | |
download | ChibiOS-9a42d5914405143eabaf1c38891c29aafcd6a77d.tar.gz ChibiOS-9a42d5914405143eabaf1c38891c29aafcd6a77d.tar.bz2 ChibiOS-9a42d5914405143eabaf1c38891c29aafcd6a77d.zip |
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2222 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r-- | os/ports/GCC/AVR/port.dox | 25 | ||||
-rw-r--r-- | os/ports/GCC/MSP430/port.dox | 7 |
2 files changed, 18 insertions, 14 deletions
diff --git a/os/ports/GCC/AVR/port.dox b/os/ports/GCC/AVR/port.dox index d5bf64f99..220f3d20a 100644 --- a/os/ports/GCC/AVR/port.dox +++ b/os/ports/GCC/AVR/port.dox @@ -54,15 +54,14 @@ /**
* @defgroup AVR_CONF Configuration Options
- * @brief AVR Configuration Options.
- * @details The AVR port allows some architecture-specific configurations
- * settings that can be overridden by redefining them in @p chconf.h.
- * Usually there is no need to change the default values.
+ * @details AVR Configuration Options. The AVR port allows some
+ * architecture-specific configurations settings that can be overridden
+ * by redefining them in @p chconf.h. Usually there is no need to change
+ * the default values.
* - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each
- * thread so be careful in order to not waste precious RAM space.<br>
- * The default value is set into <b>./os/ports/GCC/AVR/chcore.h</b>.
+ * thread so be careful in order to not waste precious RAM space.
* - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE
* thread. Usually there is no need to change this value unless inserting
* code in the IDLE thread hook macro.
@@ -70,12 +69,18 @@ * @ingroup AVR
*/
+ /**
+ * @defgroup AVR_STARTUP Startup Support
+ * @details ChibiOS/RT doed not provide startup files for the AVR, there
+ * are no special startup requirement so the normal toolchain-provided
+ * startup files can be used.
+ *
+ * @ingroup AVR
+ */
+
/**
* @defgroup AVR_CORE AVR Core Implementation
- * @brief AVR specific port code, structures and macros.
+ * @details AVR specific port code, structures and macros.
*
* @ingroup AVR
- * @file AVR/chtypes.h Port types.
- * @file AVR/chcore.h Port related structures and macros.
- * @file AVR/chcore.c Port related code.
*/
diff --git a/os/ports/GCC/MSP430/port.dox b/os/ports/GCC/MSP430/port.dox index 3f9609cf9..66f2562c8 100644 --- a/os/ports/GCC/MSP430/port.dox +++ b/os/ports/GCC/MSP430/port.dox @@ -48,8 +48,8 @@ * .
* @section MSP430_NOTES The MSP430 port notes
* - The MSP430 does not have a dedicated interrupt stack, make sure to reserve
- * enough stack space for interrupts in each thread stack. This can be done
- * by modifying the @p INT_REQUIRED_STACK configuration options.
+ * enough stack space for interrupts in each thread stack. This can be done
+ * by modifying the @p INT_REQUIRED_STACK configuration options.
* - The state of the hardware multiplier is not saved in the thread context,
* make sure to use it in <b>Suspended</b> state (interrupts masked).
* - The port code does not define the switch to a low power mode for the
@@ -69,8 +69,7 @@ * - @p INT_REQUIRED_STACK, this value represent the amount of stack space
* used by the interrupt handlers.<br>
* The default for this value is @p 32, this space is allocated for each
- * thread so be careful in order to not waste precious RAM space.<br>
- * The default value is set into <b>./os/ports/GCC/MSP430/chcore.h</b>.
+ * thread so be careful in order to not waste precious RAM space.
* - @p IDLE_THREAD_STACK_SIZE, stack area size to be assigned to the IDLE
* thread. Usually there is no need to change this value unless inserting
* code in the IDLE thread hook macro.
|