aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-12-16 18:10:15 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2012-12-16 18:10:15 +0000
commit8a377b7e20fd9550cd0a3ac34a85181c38297003 (patch)
treeda1a32acff5f3b18534d93d673c7d5d176284eb2
parent0c1c2eff08b36bf2d4b44e26c5d39c2f086029e1 (diff)
downloadChibiOS-8a377b7e20fd9550cd0a3ac34a85181c38297003.tar.gz
ChibiOS-8a377b7e20fd9550cd0a3ac34a85181c38297003.tar.bz2
ChibiOS-8a377b7e20fd9550cd0a3ac34a85181c38297003.zip
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4932 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--docs/Doxyfile_chm59
-rw-r--r--docs/Doxyfile_html59
-rw-r--r--os/hal/hal.dox4
-rw-r--r--os/ports/GCC/ARMCMx/SAM4L/vectors.c2
4 files changed, 15 insertions, 109 deletions
diff --git a/docs/Doxyfile_chm b/docs/Doxyfile_chm
index 8688f79c9..47b51c500 100644
--- a/docs/Doxyfile_chm
+++ b/docs/Doxyfile_chm
@@ -642,52 +642,8 @@ WARN_LOGFILE =
INPUT = ../docs/src \
../os/kernel \
- ../os/kernel/include \
- ../os/kernel/src \
- ../os/kernel/templates \
../os/ports \
- ../os/ports/common/ARMCMx \
- ../os/ports/GCC/ARM \
- ../os/ports/GCC/ARM/LPC214x \
- ../os/ports/GCC/ARM/AT91SAM7 \
- ../os/ports/GCC/ARMCMx \
- ../os/ports/GCC/ARMCMx/STM32F1xx \
- ../os/ports/GCC/ARMCMx/STM32L1xx \
- ../os/ports/GCC/ARMCMx/LPC11xx \
- ../os/ports/GCC/ARMCMx/LPC13xx \
- ../os/ports/GCC/PPC \
- ../os/ports/GCC/AVR \
- ../os/ports/GCC/MSP430 \
- ../os/ports/IAR/ARMCMx \
- ../os/ports/IAR/ARMCMx/STM32F1xx \
- ../os/ports/IAR/ARMCMx/STM32L1xx \
- ../os/ports/IAR/ARMCMx/LPC11xx \
- ../os/ports/IAR/ARMCMx/LPC13xx \
- ../os/ports/RVCT/ARMCMx \
- ../os/ports/RVCT/ARMCMx/STM32F1xx \
- ../os/ports/RVCT/ARMCMx/STM32L1xx \
- ../os/ports/RVCT/ARMCMx/LPC11xx \
- ../os/ports/RVCT/ARMCMx/LPC13xx \
- ../os/ports/cosmic/STM8 \
- ../os/ports/RC/STM8 \
../os/hal \
- ../os/hal/dox \
- ../os/hal/include \
- ../os/hal/src \
- ../os/hal/templates \
- ../os/hal/platforms \
- ../os/hal/platforms/AT91SAM7/platform.dox \
- ../os/hal/platforms/AVR/platform.dox \
- ../os/hal/platforms/LPC11xx/platform.dox \
- ../os/hal/platforms/LPC13xx/platform.dox \
- ../os/hal/platforms/LPC214x/platform.dox \
- ../os/hal/platforms/MSP430/platform.dox \
- ../os/hal/platforms/SPC56x/platform.dox \
- ../os/hal/platforms/STM32F1xx/platform.dox \
- ../os/hal/platforms/STM32F4xx/platform.dox \
- ../os/hal/platforms/STM32L1xx/platform.dox \
- ../os/hal/platforms/STM8L/platform.dox \
- ../os/hal/platforms/STM8S/platform.dox \
../os/various \
../test \
../ext/ext.dox
@@ -742,20 +698,17 @@ FILE_PATTERNS = *.c \
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
-RECURSIVE = NO
+RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = ../os/hal/platforms/STM32F1xx/stm32f10x.h \
- ../os/hal/platforms/STM32L1xx/stm32l10x.h \
- ../os/hal/platforms/STM8/stm8s.h \
- ../os/hal/platforms/STM8/stm8s_type.h \
- ../os/hal/platforms/LPC11xx/LPC11xx.h \
- ../os/hal/platforms/LPC11xx/system_LPC11xx.h \
- ../os/hal/platforms/LPC13xx/LPC13xx.h \
- ../os/hal/platforms/LPC13xx/system_LPC13xx.h
+EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \
+ ../os/ports/SIMIA32 \
+ ../os/hal/platforms \
+ ../os/hal/templates \
+ ../test/coverage
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
diff --git a/docs/Doxyfile_html b/docs/Doxyfile_html
index f96084966..080378d4c 100644
--- a/docs/Doxyfile_html
+++ b/docs/Doxyfile_html
@@ -642,52 +642,8 @@ WARN_LOGFILE =
INPUT = ../docs/src \
../os/kernel \
- ../os/kernel/include \
- ../os/kernel/src \
- ../os/kernel/templates \
../os/ports \
- ../os/ports/common/ARMCMx \
- ../os/ports/GCC/ARM \
- ../os/ports/GCC/ARM/LPC214x \
- ../os/ports/GCC/ARM/AT91SAM7 \
- ../os/ports/GCC/ARMCMx \
- ../os/ports/GCC/ARMCMx/STM32F1xx \
- ../os/ports/GCC/ARMCMx/STM32L1xx \
- ../os/ports/GCC/ARMCMx/LPC11xx \
- ../os/ports/GCC/ARMCMx/LPC13xx \
- ../os/ports/GCC/PPC \
- ../os/ports/GCC/AVR \
- ../os/ports/GCC/MSP430 \
- ../os/ports/IAR/ARMCMx \
- ../os/ports/IAR/ARMCMx/STM32F1xx \
- ../os/ports/IAR/ARMCMx/STM32L1xx \
- ../os/ports/IAR/ARMCMx/LPC11xx \
- ../os/ports/IAR/ARMCMx/LPC13xx \
- ../os/ports/RVCT/ARMCMx \
- ../os/ports/RVCT/ARMCMx/STM32F1xx \
- ../os/ports/RVCT/ARMCMx/STM32L1xx \
- ../os/ports/RVCT/ARMCMx/LPC11xx \
- ../os/ports/RVCT/ARMCMx/LPC13xx \
- ../os/ports/cosmic/STM8 \
- ../os/ports/RC/STM8 \
../os/hal \
- ../os/hal/dox \
- ../os/hal/include \
- ../os/hal/src \
- ../os/hal/templates \
- ../os/hal/platforms \
- ../os/hal/platforms/AT91SAM7/platform.dox \
- ../os/hal/platforms/AVR/platform.dox \
- ../os/hal/platforms/LPC11xx/platform.dox \
- ../os/hal/platforms/LPC13xx/platform.dox \
- ../os/hal/platforms/LPC214x/platform.dox \
- ../os/hal/platforms/MSP430/platform.dox \
- ../os/hal/platforms/SPC56x/platform.dox \
- ../os/hal/platforms/STM32F1xx/platform.dox \
- ../os/hal/platforms/STM32F4xx/platform.dox \
- ../os/hal/platforms/STM32L1xx/platform.dox \
- ../os/hal/platforms/STM8L/platform.dox \
- ../os/hal/platforms/STM8S/platform.dox \
../os/various \
../test \
../ext/ext.dox
@@ -742,20 +698,17 @@ FILE_PATTERNS = *.c \
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
-RECURSIVE = NO
+RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = ../os/hal/platforms/STM32F1xx/stm32f10x.h \
- ../os/hal/platforms/STM32L1xx/stm32l10x.h \
- ../os/hal/platforms/STM8/stm8s.h \
- ../os/hal/platforms/STM8/stm8s_type.h \
- ../os/hal/platforms/LPC11xx/LPC11xx.h \
- ../os/hal/platforms/LPC11xx/system_LPC11xx.h \
- ../os/hal/platforms/LPC13xx/LPC13xx.h \
- ../os/hal/platforms/LPC13xx/system_LPC13xx.h
+EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \
+ ../os/ports/SIMIA32 \
+ ../os/hal/platforms \
+ ../os/hal/templates \
+ ../test/coverage
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
diff --git a/os/hal/hal.dox b/os/hal/hal.dox
index 1ac733957..accb8fcc9 100644
--- a/os/hal/hal.dox
+++ b/os/hal/hal.dox
@@ -20,7 +20,7 @@
/**
* @defgroup IO HAL
- * @brief Hardware Abstraction Layer.
+ * @brief Hardware Abstraction Layer.
* @details Under ChibiOS/RT the set of the various device driver interfaces
* is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the
* abstract interface between ChibiOS/RT application and hardware.
@@ -73,7 +73,7 @@
/**
* @defgroup HAL_CONF Configuration
- * @brief @ref HAL Configuration.
+ * @brief HAL Configuration.
* @details The file @p halconf.h contains the high level settings for all
* the drivers supported by the HAL. The low level, platform dependent,
* settings are contained in the @p mcuconf.h file instead and are describe
diff --git a/os/ports/GCC/ARMCMx/SAM4L/vectors.c b/os/ports/GCC/ARMCMx/SAM4L/vectors.c
index 2bb769291..55fa525fc 100644
--- a/os/ports/GCC/ARMCMx/SAM4L/vectors.c
+++ b/os/ports/GCC/ARMCMx/SAM4L/vectors.c
@@ -22,7 +22,7 @@
* @file GCC/ARMCMx/SAM4L/vectors.c
* @brief Interrupt vectors for the ATSAM4L family.
*
- * @defgroup ARMCMx_STM32F4xx_VECTORS ATSAM4L Interrupt Vectors
+ * @defgroup ARMCMx_SAM4L_VECTORS ATSAM4L Interrupt Vectors
* @ingroup ARMCMx_SPECIFIC
* @details Interrupt vectors for the ATSAM4L family.
* @{