From 487a81e29725d598cf0ccdd8c9cd59c5c03634d9 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Tue, 26 Oct 2010 17:39:29 +0000
Subject: Documentation related changes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2293 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/hal/platforms/AVR/hal_lld.c    |  2 +-
 os/hal/platforms/AVR/hal_lld.h    |  2 +-
 os/hal/platforms/AVR/platform.dox | 25 ++++++++++++++++++-------
 os/hal/platforms/AVR/serial_lld.c |  2 +-
 os/hal/platforms/AVR/serial_lld.h |  2 +-
 5 files changed, 22 insertions(+), 11 deletions(-)

(limited to 'os/hal/platforms/AVR')

diff --git a/os/hal/platforms/AVR/hal_lld.c b/os/hal/platforms/AVR/hal_lld.c
index c0e694804..a3d3f4ab8 100644
--- a/os/hal/platforms/AVR/hal_lld.c
+++ b/os/hal/platforms/AVR/hal_lld.c
@@ -21,7 +21,7 @@
  * @file    AVR/hal_lld.c
  * @brief   AVR HAL subsystem low level driver code.
  *
- * @addtogroup AVR_HAL
+ * @addtogroup HAL
  * @{
  */
 
diff --git a/os/hal/platforms/AVR/hal_lld.h b/os/hal/platforms/AVR/hal_lld.h
index 9ffd46d7a..647c2f142 100644
--- a/os/hal/platforms/AVR/hal_lld.h
+++ b/os/hal/platforms/AVR/hal_lld.h
@@ -21,7 +21,7 @@
  * @file    AVR/hal_lld.h
  * @brief   AVR HAL subsystem low level driver header.
  *
- * @addtogroup AVR_HAL
+ * @addtogroup HAL
  * @{
  */
 
diff --git a/os/hal/platforms/AVR/platform.dox b/os/hal/platforms/AVR/platform.dox
index b14441ebc..9b8cf3e6b 100644
--- a/os/hal/platforms/AVR/platform.dox
+++ b/os/hal/platforms/AVR/platform.dox
@@ -19,23 +19,34 @@
 
 /**
  * @defgroup AVR_DRIVERS AVR Drivers
- * @brief AVR specific support.
+ * @details This section describes all the supported drivers on the AVR
+ *          platform and the implementation details of the single drivers.
  *
  * @ingroup platforms
  */
 
 /**
- * @defgroup AVR_HAL AVR HAL Support
- * @brief HAL support.
+ * @defgroup AVR_HAL AVR Initialization Support
+ * @details On the AVR platform the HAL driver is a stub and does not perform
+ *          any platform-specific initialization, it still performs the
+ *          initialization of the other drivers.
  *
  * @ingroup AVR_DRIVERS
  */
 
 /**
- * @defgroup AVR_SERIAL AVR USART Support
- * @brief USART support.
- * @details The serial driver supports both the AVR USARTs in asynchronous
- * mode.
+ * @defgroup AVR_SERIAL AVR USART Support (buffered)
+ * @details The AVR Serial driver uses the USART peripherals in a
+ *          buffered, interrupt driven, implementation.
  *
+ * @section avr_serial_1 Supported HW resources
+ * The serial driver can support any of the following hardware resources:
+ * - USART0.
+ * - USART1.
+ * .
+ * @section avr_serial_2 AVR Serial driver implementation features
+ * - Each USART can be independently enabled and programmed.
+ * - Fully interrupt driven.
+ * .
  * @ingroup AVR_DRIVERS
  */
diff --git a/os/hal/platforms/AVR/serial_lld.c b/os/hal/platforms/AVR/serial_lld.c
index 74f8c63b4..8fc091bed 100644
--- a/os/hal/platforms/AVR/serial_lld.c
+++ b/os/hal/platforms/AVR/serial_lld.c
@@ -21,7 +21,7 @@
  * @file    AVR/serial_lld.c
  * @brief   AVR low level serial driver code.
  *
- * @addtogroup AVR_SERIAL
+ * @addtogroup SERIAL
  * @{
  */
 
diff --git a/os/hal/platforms/AVR/serial_lld.h b/os/hal/platforms/AVR/serial_lld.h
index 604a46c99..0c558ab34 100644
--- a/os/hal/platforms/AVR/serial_lld.h
+++ b/os/hal/platforms/AVR/serial_lld.h
@@ -21,7 +21,7 @@
  * @file    AVR/serial_lld.h
  * @brief   AVR low level serial driver header.
  *
- * @addtogroup AVR_SERIAL
+ * @addtogroup SERIAL
  * @{
  */
 
-- 
cgit v1.2.3