From 87ea556758813e1b560fc59f0a6441d4efc5eef8 Mon Sep 17 00:00:00 2001
From: smlng <s@mlng.net>
Date: Tue, 18 Apr 2017 11:18:26 +0200
Subject: [PATCH] doxygen: refine Arduino Atmega Common documentation

---
 boards/arduino-atmega-common/board.c                |  3 +--
 boards/arduino-atmega-common/doc.txt                | 13 +++++++++++++
 .../arduino-atmega-common/include/arduino_board.h   |  2 +-
 .../arduino-atmega-common/include/arduino_pinmap.h  |  2 +-
 boards/arduino-atmega-common/include/board_common.h | 10 +++-------
 boards/arduino-atmega-common/include/gpio_params.h  |  6 +++---
 boards/arduino-atmega-common/include/periph_conf.h  |  3 +--
 7 files changed, 23 insertions(+), 16 deletions(-)
 create mode 100644 boards/arduino-atmega-common/doc.txt

diff --git a/boards/arduino-atmega-common/board.c b/boards/arduino-atmega-common/board.c
index 0442c112f8..3bf9296d37 100644
--- a/boards/arduino-atmega-common/board.c
+++ b/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>
diff --git a/boards/arduino-atmega-common/doc.txt b/boards/arduino-atmega-common/doc.txt
new file mode 100644
index 0000000000..c4508e5adf
--- /dev/null
+++ b/boards/arduino-atmega-common/doc.txt
@@ -0,0 +1,13 @@
+/*
+ * 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
+ */
diff --git a/boards/arduino-atmega-common/include/arduino_board.h b/boards/arduino-atmega-common/include/arduino_board.h
index f05d312589..3a8d7b958e 100644
--- a/boards/arduino-atmega-common/include/arduino_board.h
+++ b/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>
diff --git a/boards/arduino-atmega-common/include/arduino_pinmap.h b/boards/arduino-atmega-common/include/arduino_pinmap.h
index 30fc88c1cb..feac1c5bc2 100644
--- a/boards/arduino-atmega-common/include/arduino_pinmap.h
+++ b/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.
diff --git a/boards/arduino-atmega-common/include/board_common.h b/boards/arduino-atmega-common/include/board_common.h
index ee3ef7ef00..03d63b136f 100644
--- a/boards/arduino-atmega-common/include/board_common.h
+++ b/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>
diff --git a/boards/arduino-atmega-common/include/gpio_params.h b/boards/arduino-atmega-common/include/gpio_params.h
index 6f61915ff4..d703508765 100644
--- a/boards/arduino-atmega-common/include/gpio_params.h
+++ b/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
diff --git a/boards/arduino-atmega-common/include/periph_conf.h b/boards/arduino-atmega-common/include/periph_conf.h
index 2f3c9e2c06..232169c9cb 100644
--- a/boards/arduino-atmega-common/include/periph_conf.h
+++ b/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>