From 9a42d5914405143eabaf1c38891c29aafcd6a77d Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 2 Oct 2010 11:04:23 +0000 Subject: [PATCH] Documentation related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2222 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/ports/GCC/AVR/port.dox | 29 +++++++++++++++++------------ os/ports/GCC/MSP430/port.dox | 7 +++---- 2 files changed, 20 insertions(+), 16 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.
* 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.
- * The default value is set into ./os/ports/GCC/AVR/chcore.h. + * 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_CORE AVR Core Implementation - * @brief AVR specific port code, structures and macros. + /** + * @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 + * @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 Suspended 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.
* 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.
- * The default value is set into ./os/ports/GCC/MSP430/chcore.h. + * 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.