From 47eb6096b16d69364b5a78be8215c51c6edd94d5 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 23 Jun 2016 07:36:04 -0700 Subject: [PATCH] doc: fix ref in include/sensor.h 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 --- include/sensor.h | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/include/sensor.h b/include/sensor.h index 162bdf5e89b..e394ef2c0f8 100644 --- a/include/sensor.h +++ b/include/sensor.h @@ -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 @@ -479,6 +483,9 @@ enum sensor_trigger_mode { SENSOR_TRIG_MODE_GLOBAL_WQ, }; +/** + * @brief configuration parameters for sensor triggers. + */ struct sensor_trigger_config { /** * 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. * - * If @ref fiber_config.stack is non-NULL, the driver should start its - * on fiber based on @ref fiber_config. Otherwise, use @ref + * If fiber_config.stack is non-NULL, the driver should start its + * own fiber based on @ref fiber_config. Otherwise, use * sensor_interface::sensor_trigger_mode to decide if and how to use * triggering. */