From a864ebbce45563983cdb885beadadea034472a7d Mon Sep 17 00:00:00 2001
From: George Oikonomou <george@contiki-os.org>
Date: Sun, 17 Jul 2016 01:56:35 +0100
Subject: [PATCH] Re-organise sensortag documentation modules

Many of those doxygen blocks are now applicable to both sensortags, with only a couple of them being different between the CC1350 and CC2650 tags
---
 platform/srf06-cc26xx/common/ext-flash.c      |  2 +-
 .../srf06-cc26xx/sensortag/bmp-280-sensor.c   |  2 +-
 .../srf06-cc26xx/sensortag/bmp-280-sensor.h   |  2 +-
 platform/srf06-cc26xx/sensortag/board-i2c.c   |  2 +-
 platform/srf06-cc26xx/sensortag/board-i2c.h   |  2 +-
 .../sensortag/board-peripherals.h             | 11 ++++++-
 .../srf06-cc26xx/sensortag/button-sensor.c    |  2 +-
 .../srf06-cc26xx/sensortag/button-sensor.h    |  2 +-
 platform/srf06-cc26xx/sensortag/buzzer.c      |  2 +-
 platform/srf06-cc26xx/sensortag/buzzer.h      |  2 +-
 .../srf06-cc26xx/sensortag/cc1350/board.h     |  4 +--
 .../srf06-cc26xx/sensortag/cc2650/board.h     |  2 +-
 .../srf06-cc26xx/sensortag/hdc-1000-sensor.c  |  2 +-
 .../srf06-cc26xx/sensortag/hdc-1000-sensor.h  | 31 +------------------
 .../srf06-cc26xx/sensortag/mpu-9250-sensor.c  |  2 +-
 .../srf06-cc26xx/sensortag/mpu-9250-sensor.h  |  2 +-
 .../srf06-cc26xx/sensortag/opt-3001-sensor.c  |  2 +-
 .../srf06-cc26xx/sensortag/opt-3001-sensor.h  |  2 +-
 platform/srf06-cc26xx/sensortag/reed-relay.c  |  2 +-
 platform/srf06-cc26xx/sensortag/reed-relay.h  |  2 +-
 .../srf06-cc26xx/sensortag/sensor-common.h    |  2 +-
 .../sensortag/sensortag-sensors.c             |  2 +-
 .../srf06-cc26xx/sensortag/tmp-007-sensor.c   |  2 +-
 .../srf06-cc26xx/sensortag/tmp-007-sensor.h   |  2 +-
 24 files changed, 34 insertions(+), 54 deletions(-)

diff --git a/platform/srf06-cc26xx/common/ext-flash.c b/platform/srf06-cc26xx/common/ext-flash.c
index 7faaab0c0..5631297ac 100644
--- a/platform/srf06-cc26xx/common/ext-flash.c
+++ b/platform/srf06-cc26xx/common/ext-flash.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the LaunchPad Flash and the Sensortag WinBond W25X20CL/W25X40CL
+ * Sensortag/LaunchPad External Flash Driver
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki.h"
diff --git a/platform/srf06-cc26xx/sensortag/bmp-280-sensor.c b/platform/srf06-cc26xx/sensortag/bmp-280-sensor.c
index 4ed9e06fc..a6e525cb1 100644
--- a/platform/srf06-cc26xx/sensortag/bmp-280-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/bmp-280-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26XX BMP280 Altimeter / Pressure Sensor
+ *  Driver for the Sensortag BMP280 Altimeter / Pressure Sensor
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/bmp-280-sensor.h b/platform/srf06-cc26xx/sensortag/bmp-280-sensor.h
index 8bff65787..0047aaa9a 100644
--- a/platform/srf06-cc26xx/sensortag/bmp-280-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/bmp-280-sensor.h
@@ -49,7 +49,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx BMP280 Altimeter / Pressure Sensor
+ * Header file for the Sensortag BMP280 Altimeter / Pressure Sensor
  */
 /*---------------------------------------------------------------------------*/
 #ifndef BMP_280_SENSOR_H_
diff --git a/platform/srf06-cc26xx/sensortag/board-i2c.c b/platform/srf06-cc26xx/sensortag/board-i2c.c
index 17486d65b..262ef4772 100644
--- a/platform/srf06-cc26xx/sensortag/board-i2c.c
+++ b/platform/srf06-cc26xx/sensortag/board-i2c.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- * Board-specific I2C driver for the Sensortag-CC26xx
+ * Board-specific I2C driver for the Sensortags
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/board-i2c.h b/platform/srf06-cc26xx/sensortag/board-i2c.h
index 40832c9bd..46233c332 100644
--- a/platform/srf06-cc26xx/sensortag/board-i2c.h
+++ b/platform/srf06-cc26xx/sensortag/board-i2c.h
@@ -36,7 +36,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx I2C Driver
+ * Header file for the Sensortag I2C Driver
  */
 /*---------------------------------------------------------------------------*/
 #ifndef BOARD_I2C_H_
diff --git a/platform/srf06-cc26xx/sensortag/board-peripherals.h b/platform/srf06-cc26xx/sensortag/board-peripherals.h
index 9c994d9e6..42e22d4c8 100644
--- a/platform/srf06-cc26xx/sensortag/board-peripherals.h
+++ b/platform/srf06-cc26xx/sensortag/board-peripherals.h
@@ -29,10 +29,18 @@
  */
 /*---------------------------------------------------------------------------*/
 /** \addtogroup cc26xx-srf-tag
+ * @{
+ *
+ * \defgroup sensortag-cc26xx-peripherals Sensortag CC1350/CC2650 common
+ *
+ * Defines related to Sensortag sensors. The two sensortags are identical to a
+ * very large extent. Everything documented within this group applies to both
+ * sensortags.
+ *
  * @{
  *
  * \file
- * Header file with definitions related to the sensors on the Sensortag-CC26xx
+ * Header file with definitions related to the sensors on the Sensortags
  *
  * \note   Do not include this file directly.
  */
@@ -52,5 +60,6 @@
 #endif /* BOARD_PERIPHERALS_H_ */
 /*---------------------------------------------------------------------------*/
 /**
+ * @}
  * @}
  */
diff --git a/platform/srf06-cc26xx/sensortag/button-sensor.c b/platform/srf06-cc26xx/sensortag/button-sensor.c
index 9df55d21d..7ec0a5a18 100644
--- a/platform/srf06-cc26xx/sensortag/button-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/button-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- * Driver for the Sensortag-CC26xx buttons
+ * Driver for Sensortag buttons
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki.h"
diff --git a/platform/srf06-cc26xx/sensortag/button-sensor.h b/platform/srf06-cc26xx/sensortag/button-sensor.h
index 25acb104f..1355a5855 100644
--- a/platform/srf06-cc26xx/sensortag/button-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/button-sensor.h
@@ -38,7 +38,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx Button Driver
+ * Header file for the Sensortag Button Driver
  */
 /*---------------------------------------------------------------------------*/
 #ifndef BUTTON_SENSOR_H_
diff --git a/platform/srf06-cc26xx/sensortag/buzzer.c b/platform/srf06-cc26xx/sensortag/buzzer.c
index d7f48e4de..47ce799d4 100644
--- a/platform/srf06-cc26xx/sensortag/buzzer.c
+++ b/platform/srf06-cc26xx/sensortag/buzzer.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26XX Buzzer
+ *  Driver for the Sensortag Buzzer
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/buzzer.h b/platform/srf06-cc26xx/sensortag/buzzer.h
index 653b46f88..679729245 100644
--- a/platform/srf06-cc26xx/sensortag/buzzer.h
+++ b/platform/srf06-cc26xx/sensortag/buzzer.h
@@ -36,7 +36,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx Buzzer
+ * Header file for the Sensortag Buzzer
  */
 /*---------------------------------------------------------------------------*/
 #ifndef BUZZER_H_
diff --git a/platform/srf06-cc26xx/sensortag/cc1350/board.h b/platform/srf06-cc26xx/sensortag/cc1350/board.h
index a98b955b2..7db4c9357 100644
--- a/platform/srf06-cc26xx/sensortag/cc1350/board.h
+++ b/platform/srf06-cc26xx/sensortag/cc1350/board.h
@@ -31,9 +31,9 @@
 /** \addtogroup cc26xx-srf-tag
  * @{
  *
- * \defgroup sensortag-cc13xx-peripherals Sensortag Peripherals
+ * \defgroup sensortag-cc13xx-peripherals CC1350 Sensortag Peripherals
  *
- * Defines related to the Sensortag-CC1350
+ * Defines related to the CC1350 Sensortag
  *
  * This file provides connectivity information on LEDs, Buttons, UART and
  * other peripherals
diff --git a/platform/srf06-cc26xx/sensortag/cc2650/board.h b/platform/srf06-cc26xx/sensortag/cc2650/board.h
index 9f0a7abd3..aaf26dae3 100644
--- a/platform/srf06-cc26xx/sensortag/cc2650/board.h
+++ b/platform/srf06-cc26xx/sensortag/cc2650/board.h
@@ -31,7 +31,7 @@
 /** \addtogroup cc26xx-srf-tag
  * @{
  *
- * \defgroup sensortag-cc26xx-peripherals Sensortag Peripherals
+ * \defgroup sensortag-cc26xx-specific CC2650 Sensortag Peripherals
  *
  * Defines related to the CC2650 Sensortag
  *
diff --git a/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.c b/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.c
index 8fdd6d847..bdc688fe4 100644
--- a/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26xx HDC sensor
+ *  Driver for the Sensortag HDC sensor
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.h b/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.h
index 990b1ab69..d3089d742 100755
--- a/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/hdc-1000-sensor.h
@@ -1,32 +1,3 @@
-/*
- * Copyright (c) 2014, Texas Instruments Incorporated - http://www.ti.com/
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 3. Neither the name of the copyright holder nor the names of its
- *    contributors may be used to endorse or promote products derived
- *    from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
- * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
- * OF THE POSSIBILITY OF SUCH DAMAGE.
- */
 /*
  * Copyright (c) 2014, Texas Instruments Incorporated - http://www.ti.com/
  * All rights reserved.
@@ -85,7 +56,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26ss TI HDC1000 sensor
+ * Header file for the Sensortag TI HDC1000 sensor
  */
 /*---------------------------------------------------------------------------*/
 #ifndef HDC_1000_SENSOR_H
diff --git a/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.c b/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.c
index 5a97666b3..886cccb6e 100644
--- a/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26XX Invensense MPU9250 motion processing unit
+ *  Driver for the Sensortag Invensense MPU9250 motion processing unit
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.h b/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.h
index c6c4d5534..da4386412 100644
--- a/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/mpu-9250-sensor.h
@@ -62,7 +62,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26XX Invensense MPU9250 motion processing unit
+ * Header file for the Sensortag Invensense MPU9250 motion processing unit
  */
 /*---------------------------------------------------------------------------*/
 #ifndef MPU_9250_SENSOR_H_
diff --git a/platform/srf06-cc26xx/sensortag/opt-3001-sensor.c b/platform/srf06-cc26xx/sensortag/opt-3001-sensor.c
index 7d903e18b..a9b7ba01f 100644
--- a/platform/srf06-cc26xx/sensortag/opt-3001-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/opt-3001-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26xx Opt3001 light sensor
+ *  Driver for the Sensortag Opt3001 light sensor
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/opt-3001-sensor.h b/platform/srf06-cc26xx/sensortag/opt-3001-sensor.h
index a4160b729..e9fa379a4 100644
--- a/platform/srf06-cc26xx/sensortag/opt-3001-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/opt-3001-sensor.h
@@ -53,7 +53,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx Opt3001 light sensor
+ * Header file for the Sensortag Opt3001 light sensor
  */
 /*---------------------------------------------------------------------------*/
 #ifndef OPT_3001_SENSOR_H_
diff --git a/platform/srf06-cc26xx/sensortag/reed-relay.c b/platform/srf06-cc26xx/sensortag/reed-relay.c
index 598bfd970..8cecad9d6 100644
--- a/platform/srf06-cc26xx/sensortag/reed-relay.c
+++ b/platform/srf06-cc26xx/sensortag/reed-relay.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26XX Reed Relay
+ *  Driver for the Sensortag Reed Relay
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki.h"
diff --git a/platform/srf06-cc26xx/sensortag/reed-relay.h b/platform/srf06-cc26xx/sensortag/reed-relay.h
index 3ec712719..0ed6dd819 100644
--- a/platform/srf06-cc26xx/sensortag/reed-relay.h
+++ b/platform/srf06-cc26xx/sensortag/reed-relay.h
@@ -41,7 +41,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26XX Reed Relay
+ * Header file for the Sensortag Reed Relay
  */
 /*---------------------------------------------------------------------------*/
 #ifndef REED_RELAY_H
diff --git a/platform/srf06-cc26xx/sensortag/sensor-common.h b/platform/srf06-cc26xx/sensortag/sensor-common.h
index 977650d5e..7f2bab4f1 100644
--- a/platform/srf06-cc26xx/sensortag/sensor-common.h
+++ b/platform/srf06-cc26xx/sensortag/sensor-common.h
@@ -36,7 +36,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx Common sensor utilities
+ * Header file for the Sensortag Common sensor utilities
  */
 /*---------------------------------------------------------------------------*/
 #ifndef SENSOR_H
diff --git a/platform/srf06-cc26xx/sensortag/sensortag-sensors.c b/platform/srf06-cc26xx/sensortag/sensortag-sensors.c
index bcd0fe367..26d08591d 100644
--- a/platform/srf06-cc26xx/sensortag/sensortag-sensors.c
+++ b/platform/srf06-cc26xx/sensortag/sensortag-sensors.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- * Generic module controlling sensors on CC26XX Sensortag
+ * Generic module controlling sensors on Sensortags
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki.h"
diff --git a/platform/srf06-cc26xx/sensortag/tmp-007-sensor.c b/platform/srf06-cc26xx/sensortag/tmp-007-sensor.c
index 1c462a0e0..fdbd975b1 100644
--- a/platform/srf06-cc26xx/sensortag/tmp-007-sensor.c
+++ b/platform/srf06-cc26xx/sensortag/tmp-007-sensor.c
@@ -33,7 +33,7 @@
  * @{
  *
  * \file
- *  Driver for the Sensortag-CC26xx TI TMP007 infrared thermophile sensor
+ *  Driver for the Sensortag TI TMP007 infrared thermophile sensor
  */
 /*---------------------------------------------------------------------------*/
 #include "contiki-conf.h"
diff --git a/platform/srf06-cc26xx/sensortag/tmp-007-sensor.h b/platform/srf06-cc26xx/sensortag/tmp-007-sensor.h
index 10c96c8a0..5260c9152 100644
--- a/platform/srf06-cc26xx/sensortag/tmp-007-sensor.h
+++ b/platform/srf06-cc26xx/sensortag/tmp-007-sensor.h
@@ -56,7 +56,7 @@
  * @{
  *
  * \file
- * Header file for the Sensortag-CC26xx TI TMP007 infrared thermophile sensor
+ * Header file for the Sensortag TI TMP007 infrared thermophile sensor
  */
 /*---------------------------------------------------------------------------*/
 #ifndef TMP_007_SENSOR_H_