From 8cb1e794a51c9362a657bb03c5d38b78eba3bb2e Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 25 Feb 2013 13:38:45 +0000 Subject: [PATCH] Documentation improvements. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@5322 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/Doxyfile_chm | 2 +- docs/Doxyfile_html | 2 +- os/ports/IAR/STM8/port.dox | 4 ++-- readme.txt | 4 ++++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/Doxyfile_chm b/docs/Doxyfile_chm index cb38f1ce9..c809b3cbe 100644 --- a/docs/Doxyfile_chm +++ b/docs/Doxyfile_chm @@ -707,7 +707,7 @@ RECURSIVE = YES EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \ ../os/ports/GCC/SIMIA32 \ ../os/hal/platforms \ - ../os/hal/templates \ + ../os/hal/templates/meta \ ../os/various\devices_lib \ ../os/various\fatfs_bindings \ ../os/various\lwip_bindings \ diff --git a/docs/Doxyfile_html b/docs/Doxyfile_html index 8e7aa791b..0c1f8acb8 100644 --- a/docs/Doxyfile_html +++ b/docs/Doxyfile_html @@ -707,7 +707,7 @@ RECURSIVE = YES EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \ ../os/ports/GCC/SIMIA32 \ ../os/hal/platforms \ - ../os/hal/templates \ + ../os/hal/templates/meta \ ../os/various\devices_lib \ ../os/various\fatfs_bindings \ ../os/various\lwip_bindings \ diff --git a/os/ports/IAR/STM8/port.dox b/os/ports/IAR/STM8/port.dox index 898fb8d4e..c0eb35cdd 100644 --- a/os/ports/IAR/STM8/port.dox +++ b/os/ports/IAR/STM8/port.dox @@ -52,7 +52,7 @@ * - The STM8 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 macro into - * ./os/ports/cosmic/STM8/chcore.h. + * ./os/ports/IAR/STM8/chcore.h. * - The kernel currently supports only the small memory model so the * kernel files should be loaded in the first 64K. Note that this is not * a problem because upper addresses can be used by the user code, the @@ -61,7 +61,7 @@ * because the missing support of the @p inline "C" keyword in the * compiler. * . - * @ingroup cosmic + * @ingroup iar */ /** diff --git a/readme.txt b/readme.txt index 5f17a28ec..683ba83ab 100644 --- a/readme.txt +++ b/readme.txt @@ -119,6 +119,10 @@ (backported to 2.4.3). - FIX: Fixed wrong SPI path in platform_f105_f107.mk (bug 3598151). - FIX: Fixed PHY powerdown issues not fixed (bug 3596911). +- NEW: Now the general documentation includes data extracted from the low + level driver templates. Per-platform/architecture documents are no more + required and will be replaced with technical articles and examples for + each specific driver. - NEW: Added a build test project for low level device driver templates. - NEW: Enhanced CAN driver model, support for mailboxes has been added. STM32 driver implementation upgraded.