michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix ref in include/sensor.h

Browse source 
Added missing (placeholder) comment on struct sensor_trigger_config

Removed @ref references to undefined terms

Fixed a misspelling while I was there too.

Jira: ZEP-487
Change-Id: I314f243cbd58cab48da33abd2f181b9aeb17b0e9
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2016-06-23 07:36:04 -07:00 • committed by Inaky Perez-Gonzalez
commit 47eb6096b1
1 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/sensor.h
View file

@ -1,4 +1,8 @@
/* sensor.h - public sensor driver API */ /**
* @file sensor.h
*
* @brief Public APIs for the sensor driver.
*/
/* /*
* Copyright (c) 2016 Intel Corporation * Copyright (c) 2016 Intel Corporation
@ -479,6 +483,9 @@ enum sensor_trigger_mode {
SENSOR_TRIG_MODE_GLOBAL_WQ, SENSOR_TRIG_MODE_GLOBAL_WQ,
}; };
/**
* @brief configuration parameters for sensor triggers.
*/
struct sensor_trigger_config { struct sensor_trigger_config {
/** /**
* This is always set to NULL when using a @ref * This is always set to NULL when using a @ref
@ -492,8 +499,8 @@ struct sensor_trigger_config {
/** /**
* @brief Structure used for sensor trigger configuration. * @brief Structure used for sensor trigger configuration.
* *
* If @ref fiber_config.stack is non-NULL, the driver should start its * If fiber_config.stack is non-NULL, the driver should start its
* on fiber based on @ref fiber_config. Otherwise, use @ref * own fiber based on @ref fiber_config. Otherwise, use
* sensor_interface::sensor_trigger_mode to decide if and how to use * sensor_interface::sensor_trigger_mode to decide if and how to use
* triggering. * triggering.
*/ */