giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Re-organise sensortag documentation modules

Browse Source 
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
This commit is contained in:
George Oikonomou 2016-07-17 01:56:35 +01:00 committed by Simon Duquennoy
parent 87e7bdbcbd
commit 6216b7f8e6
24 changed files with 34 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
platform/srf06-cc26xx/common/ext-flash.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the LaunchPad Flash and the Sensortag WinBond W25X20CL/W25X40CL
* Sensortag/LaunchPad External Flash Driver
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"

2
platform/srf06-cc26xx/sensortag/bmp-280-sensor.c
View File

@ -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"

2
platform/srf06-cc26xx/sensortag/bmp-280-sensor.h
View File

@ -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_

2
platform/srf06-cc26xx/sensortag/board-i2c.c
View File

@ -34,7 +34,7 @@
* @{
*
* \file
* Board-specific I2C driver for the Sensortag-CC26xx
* Board-specific I2C driver for the Sensortags
*/
/*---------------------------------------------------------------------------*/
#include "contiki-conf.h"

2
platform/srf06-cc26xx/sensortag/board-i2c.h
View File

@ -36,7 +36,7 @@
* @{
*
* \file
* Header file for the Sensortag-CC26xx I2C Driver
* Header file for the Sensortag I2C Driver
*/
/*---------------------------------------------------------------------------*/
#ifndef BOARD_I2C_H_

11
platform/srf06-cc26xx/sensortag/board-peripherals.h
View File

@ -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_ */
/*---------------------------------------------------------------------------*/
/**
* @}
* @}
*/

2
platform/srf06-cc26xx/sensortag/button-sensor.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the Sensortag-CC26xx buttons
* Driver for Sensortag buttons
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"

2
platform/srf06-cc26xx/sensortag/button-sensor.h
View File

@ -38,7 +38,7 @@
* @{
*
* \file
* Header file for the Sensortag-CC26xx Button Driver
* Header file for the Sensortag Button Driver
*/
/*---------------------------------------------------------------------------*/
#ifndef BUTTON_SENSOR_H_

2
platform/srf06-cc26xx/sensortag/buzzer.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the Sensortag-CC26XX Buzzer
* Driver for the Sensortag Buzzer
*/
/*---------------------------------------------------------------------------*/
#include "contiki-conf.h"

2
platform/srf06-cc26xx/sensortag/buzzer.h
View File

@ -36,7 +36,7 @@
* @{
*
* \file
* Header file for the Sensortag-CC26xx Buzzer
* Header file for the Sensortag Buzzer
*/
/*---------------------------------------------------------------------------*/
#ifndef BUZZER_H_

4
platform/srf06-cc26xx/sensortag/cc1350/board.h
View File

@ -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

2
platform/srf06-cc26xx/sensortag/cc2650/board.h
View File

@ -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
*

2
platform/srf06-cc26xx/sensortag/hdc-1000-sensor.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the Sensortag-CC26xx HDC sensor
* Driver for the Sensortag HDC sensor
*/
/*---------------------------------------------------------------------------*/
#include "contiki-conf.h"

31
platform/srf06-cc26xx/sensortag/hdc-1000-sensor.h
View File

@ -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

2
platform/srf06-cc26xx/sensortag/mpu-9250-sensor.c
View File

@ -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"

2
platform/srf06-cc26xx/sensortag/mpu-9250-sensor.h
View File

@ -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_

2
platform/srf06-cc26xx/sensortag/opt-3001-sensor.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the Sensortag-CC26xx Opt3001 light sensor
* Driver for the Sensortag Opt3001 light sensor
*/
/*---------------------------------------------------------------------------*/
#include "contiki-conf.h"

2
platform/srf06-cc26xx/sensortag/opt-3001-sensor.h
View File

@ -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_

2
platform/srf06-cc26xx/sensortag/reed-relay.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Driver for the Sensortag-CC26XX Reed Relay
* Driver for the Sensortag Reed Relay
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"

2
platform/srf06-cc26xx/sensortag/reed-relay.h
View File

@ -41,7 +41,7 @@
* @{
*
* \file
* Header file for the Sensortag-CC26XX Reed Relay
* Header file for the Sensortag Reed Relay
*/
/*---------------------------------------------------------------------------*/
#ifndef REED_RELAY_H

2
platform/srf06-cc26xx/sensortag/sensor-common.h
View File

@ -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

2
platform/srf06-cc26xx/sensortag/sensortag-sensors.c
View File

@ -33,7 +33,7 @@
* @{
*
* \file
* Generic module controlling sensors on CC26XX Sensortag
* Generic module controlling sensors on Sensortags
*/
/*---------------------------------------------------------------------------*/
#include "contiki.h"

2
platform/srf06-cc26xx/sensortag/tmp-007-sensor.c
View File

@ -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"

2
platform/srf06-cc26xx/sensortag/tmp-007-sensor.h
View File

@ -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_