Merge pull request #6920 from smlng/doc/arduino_common

doxygen: refine Arduino Atmega Common documentation

boards/arduino-atmega-common/board.c

@@ -13,8 +13,7 @@
  * @{
  *
  * @file
- * @brief       Board specific implementations for the arduino Uno
- * @brief       and Duemilanove boards.
+ * @brief       Common implementations for Arduino Atmega boards
  *
  * @author      Hinnerk van Bruinehsen <h.v.bruinehsen@fu-berlin.de>
  * @author      Kaspar Schleiser <kaspar@schleiser.de>

boards/arduino-atmega-common/doc.txt

+/*
+ * Copyright (C) 2017 HAW Hamburg
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @defgroup    boards_arduino-atmega-common Arduino Atmega Common
+ * @ingroup     boards
+ * @brief       Common configuration and settings for Arduino Atmega boards
+ */

boards/arduino-atmega-common/include/arduino_board.h

@@ -11,7 +11,7 @@
  * @{
  *
  * @file
- * @brief       Board specific configuration for the Arduino API
+ * @brief       Configuration of the Arduino API for Arduino Atmega boards
  *
  * @author      Hauke Petersen  <hauke.petersen@fu-berlin.de>
  * @author      Laurent Navet   <laurent.navet@gmail.com>

boards/arduino-atmega-common/include/arduino_pinmap.h

@@ -12,7 +12,7 @@
  * @{
  *
  * @file
- * @brief       Mapping from MCU pins to Arduino pins
+ * @brief       Mapping from MCU pins to Arduino pins for Arduino Atmega boards
  *
  * You can use the defines in this file for simplified interaction with the
  * Arduino specific pin numbers.

boards/arduino-atmega-common/include/board_common.h

@@ -7,16 +7,12 @@
  * directory for more details.
  */
 
-/**
- * @defgroup    boards_arduino-atmega-common Arduino common
- * @ingroup     boards
- * @brief       Board specific files for the arduino Uno and
- * @brief       Duemilanove boards.
+/*
+ * @ingroup     boards_arduino-atmega-common
  * @{
  *
  * @file
- * @brief       Board specific definitions for the arduino Uno and
- * @brief       Duemilanove boards.
+ * @brief       Common board configuration for Arduino Atmega boards
  *
  * @author      Hinnerk van Bruinehsen <h.v.bruinehsen@fu-berlin.de>
  * @author      Laurent Navet <laurent.navet@gmail.com>

boards/arduino-atmega-common/include/gpio_params.h

@@ -7,13 +7,13 @@
  */
 
 /**
- * @ingroup   boards_arduino-atmega-common
+ * @ingroup     boards_arduino-atmega-common
  * @{
  *
  * @file
- * @brief     Board specific configuration of direct mapped GPIOs
+ * @brief       Common configuration of mapped GPIOs for Arduino Atmega boards
  *
- * @author    Hauke Petersen <hauke.petersen@fu-berlin.de>
+ * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
  */
 
 #ifndef GPIO_PARAMS_H

boards/arduino-atmega-common/include/periph_conf.h

@@ -12,8 +12,7 @@
  * @{
  *
  * @file
- * @brief       Peripheral MCU configuration for the arduino Uno and
- * @brief       Dumilanove boards.
+ * @brief       Common configuration of MCU periphery for Arduino Atmega boards
  *
  * @author      Hinnerk van Bruinehsen <h.v.bruinehsen@fu-berlin.de>
  * @author      Laurent Navet <laurent.navet@gmail.com>