From 97655f864658724798304d5e6406b0051a4b9f7e Mon Sep 17 00:00:00 2001 From: sunxuejiao Date: Fri, 17 Jun 2022 14:44:58 +0800 Subject: [PATCH] modify sensor/vibrator/light chinese notes Signed-off-by: sunxuejiao --- zh-cn/device_api/{ => hdi}/light/light.type.h | 41 +++-- zh-cn/device_api/{ => hdi}/light/light_if.h | 29 ++-- zh-cn/device_api/{ => hdi}/sensor/sensor_if.h | 58 +++---- .../device_api/{ => hdi}/sensor/sensor_type.h | 156 +++++++++--------- .../{ => hdi}/vibrator/vibrator_if.h | 14 +- .../{ => hdi}/vibrator/vibrator_type.h | 4 +- 6 files changed, 148 insertions(+), 154 deletions(-) rename zh-cn/device_api/{ => hdi}/light/light.type.h (74%) rename zh-cn/device_api/{ => hdi}/light/light_if.h (70%) rename zh-cn/device_api/{ => hdi}/sensor/sensor_if.h (71%) rename zh-cn/device_api/{ => hdi}/sensor/sensor_type.h (66%) rename zh-cn/device_api/{ => hdi}/vibrator/vibrator_if.h (87%) rename zh-cn/device_api/{ => hdi}/vibrator/vibrator_type.h (91%) diff --git a/zh-cn/device_api/light/light.type.h b/zh-cn/device_api/hdi/light/light.type.h similarity index 74% rename from zh-cn/device_api/light/light.type.h rename to zh-cn/device_api/hdi/light/light.type.h index b00e7586..9e9953b8 100644 --- a/zh-cn/device_api/light/light.type.h +++ b/zh-cn/device_api/hdi/light/light.type.h @@ -14,14 +14,13 @@ */ /** - * @addtogroup 灯 + * @addtogroup Light * @{ * * @brief 灯模块对灯服务提供通用的接口能力。 * * 灯模块为灯服务提供通用的接口去访问灯驱动。 - * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息。 - * 打开或关闭灯，并根据灯id设置灯闪烁模式。 + * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 * * @since 3.1 */ @@ -29,7 +28,7 @@ /** * @file Light_if.h * - * @brief 定义灯的数据结构，包括灯id，灯的模式，灯的闪烁模式和持续时间，灯的状态，灯的效果。 + * @brief 定义灯的数据结构，包括灯ID、灯的模式、灯的闪烁模式和持续时间、灯的状态、灯的效果。 * @since 3.1 */ @@ -50,31 +49,31 @@ extern "C" { */ enum LightStatus { - /** 操作成功 */ + /** 操作成功。 */ LIGHT_SUCCESS = 0, - /** 灯id不支持 */ + /** 灯ID不支持。 */ LIGHT_NOT_SUPPORT = -1, - /** 设置闪烁不支持 */ + /** 设置闪烁不支持。 */ LIGHT_NOT_FLASH = -2, - /** 设置亮度不支持 */ + /** 设置亮度不支持。 */ LIGHT_NOT_BRIGHTNESS = -3, }; /** - * @brief 枚举灯ids + * @brief 枚举灯类型 * * @since 3.1 */ enum LightId { - /** 未知id */ + /** 未知ID。 */ LIGHT_ID_NONE = 0, - /** 电源指示灯 */ + /** 电源指示灯。 */ LIGHT_ID_BATTERY = 1, - /** 通知灯 */ + /** 通知灯。 */ LIGHT_ID_NOTIFICATIONS = 2, - /** 报警灯 */ + /** 报警灯。 */ LIGHT_ID_ATTENTION = 3, - /** 无效id */ + /** 无效ID。 */ LIGHT_ID_BUTT = 4, }; @@ -84,11 +83,11 @@ enum LightId { * @since 3.1 */ enum LightFlashMode { - /** 常亮 */ + /** 常亮。 */ LIGHT_FLASH_NONE = 0, - /** 闪烁 */ + /** 闪烁。 */ LIGHT_FLASH_TIMED = 1, - /** 无效模式 */ + /** 无效模式。 */ LIGHT_FLASH_BUTT = 2, }; @@ -100,7 +99,7 @@ enum LightFlashMode { * @since 3.1 */ struct LightFlashEffect { - /** 闪烁模式。详见{@link LightFlashMode}. */ + /** 闪烁模式，详见{@link LightFlashMode}。 */ int32_t flashMode; /** 表示灯在闪烁期间点亮时持续的时间（毫秒）。 */ int32_t onTime; @@ -121,19 +120,19 @@ struct LightEffect { * 如果字节段不等于0，指示打开相应颜色的灯。 */ int32_t lightBrightness; - /** 闪烁模式。详见{@link LightFlashEffect}. */ + /** 闪烁模式。详见{@link LightFlashEffect}。 */ struct LightFlashEffect flashEffect; }; /** * @brief 定义灯的基本信息。 * - * 基本的灯信息包括灯id和自定义扩展信息。 + * 基本的灯信息包括灯ID和自定义扩展信息。 * * @since 3.1 */ struct LightInfo { - /** 灯id。 详见{@link LightId}. */ + /** 灯ID，详见{@link LightId}。 */ uint32_t lightId; /** 自定义扩展信息。 */ int32_t reserved; diff --git a/zh-cn/device_api/light/light_if.h b/zh-cn/device_api/hdi/light/light_if.h similarity index 70% rename from zh-cn/device_api/light/light_if.h rename to zh-cn/device_api/hdi/light/light_if.h index 4c3d87fe..7185d22e 100644 --- a/zh-cn/device_api/light/light_if.h +++ b/zh-cn/device_api/hdi/light/light_if.h @@ -14,14 +14,13 @@ */ /** - * @addtogroup 灯 + * @addtogroup Light * @{ * * @brief 灯模块对灯服务提供通用的接口能力。 * * 灯模块为灯服务提供通用的接口去访问灯驱动。 - * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息。 - * 打开或关闭灯，并根据灯id设置灯闪烁模式。 + * 服务获取灯驱动对象或代理后，可以调用相关的APIs接口获取灯信息、打开或关闭灯，并根据灯ID设置灯闪烁模式。 * * @since 3.1 */ @@ -29,7 +28,7 @@ /** * @file Light_if.h * - * @brief 定义灯的数据结构，包括灯id，灯的模式，灯的闪烁模式和持续时间，操作灯返回的状态，灯的效果。 + * @brief 声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。 * @since 3.1 */ @@ -48,14 +47,14 @@ extern "C" { /** * @brief 定义可以在灯上执行的基本操作。 * - * 操作包括获取灯的信息, 打开或关闭灯，设置灯的亮度或闪烁模式。 + * 操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。 */ struct LightInterface { /** * @brief 获取当前系统中所有类型的灯信息。 * - * @param lightInfo 表示指向灯信息的二级指针。详见{@link LightInfo}。 + * @param lightInfo 表示指向灯信息的二级指针，详见{@link LightInfo}。 * @param count 表示指向灯数量的指针。 * * @return 如果操作成功，则返回0。 @@ -63,35 +62,35 @@ struct LightInterface { * * @since 3.1 */ - int32_t (*GetLightInfo)(struct LightInfo **lightInfo, uint32_t *count); + int32_t (*GetLightInfo)([out] struct LightInfo **lightInfo, [out] uint32_t *count); /** - * @brief 根据指定的灯id打开列表中的可用灯。 + * @brief 根据指定的灯ID打开列表中的可用灯。 * - * @param lightId 表示灯id。详见{@link LightId}。 + * @param lightId 表示灯ID，详见{@link LightId}。 * @param effect 表示指向灯效果的指针，如果lightbrightness字段为0时， - * 灯的亮度根据HCS配置的默认亮度进行设置。详见{@link LightEffect}。 + * 灯的亮度根据HCS配置的默认亮度进行设置，详见{@link LightEffect}。 * * @return 如果操作成功，则返回0。 - * @return 如果不支持灯id，则返回-1。 + * @return 如果不支持灯ID，则返回-1。 * @return 如果不支持闪烁设置，则返回-2。 * @return 如果不支持亮度设置，则返回3。 * * @since 3.1 */ - int32_t (*TurnOnLight)(uint32_t lightId, struct LightEffect *effect); + int32_t (*TurnOnLight)([in] uint32_t lightId, [in] struct LightEffect *effect); /** - * @brief 根据指定的灯id打开列表中的可用灯。 + * @brief 根据指定的灯ID关闭列表中的可用灯。 * - * @param lightId 表示灯id。详见{@link LightId}。 + * @param lightId 表示灯ID，详见{@link LightId}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 * * @since 3.1 */ - int32_t (*TurnOffLight)(uint32_t lightId); + int32_t (*TurnOffLight)([in] uint32_t lightId); }; /** diff --git a/zh-cn/device_api/sensor/sensor_if.h b/zh-cn/device_api/hdi/sensor/sensor_if.h similarity index 71% rename from zh-cn/device_api/sensor/sensor_if.h rename to zh-cn/device_api/hdi/sensor/sensor_if.h index 46924614..06296bdc 100644 --- a/zh-cn/device_api/sensor/sensor_if.h +++ b/zh-cn/device_api/hdi/sensor/sensor_if.h @@ -14,13 +14,13 @@ */ /** - * @addtogroup 传感器 + * @addtogroup Sensor * @{ * * @brief 传感器设备驱动对传感器服务提供通用的接口能力。 * * 模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后，通过其提供的各类方法，实现获取传感器设备信息、订阅/去订阅传感器数据、 - * 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置等。 + * 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 * * @since 2.2 */ @@ -49,15 +49,14 @@ extern "C" { /** * @brief 提供sensor设备基本控制操作接口。 * - * 结构体提供获取传感器设备信息、订阅/去订阅传感器数据、 - * 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 + * 结构体提供获取传感器设备信息、订阅/去订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。 */ struct SensorInterface { /** * @brief 获取当前系统中所有类型的传感器信息。 * * @param sensorInfo 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、 - * 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗。详见{@link SensorInformation}。 + * 固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见{@link SensorInformation}。 * @param count 输出系统中注册的传感器数量。 * * @return 如果操作成功，则返回0。 @@ -66,12 +65,12 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*GetAllSensors)(struct SensorInformation **sensorInfo, int32_t *count); + int32_t (*GetAllSensors)([out] struct SensorInformation **sensorInfo, [out] int32_t *count); /** * @brief 根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。 * - * @param sensorId 唯一标识一个传感器设备类型。详见{@link SensorTypeTag}。 + * @param sensorId 唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 @@ -79,12 +78,12 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Enable)(int32_t sensorId); + int32_t (*Enable)([in] int32_t sensorId); /** - * @brief 去使能一种传感器设备。 + * @brief 根据传感器设备类型标识去使能传感器信息列表里存在的设备。 * - * @param sensorId 唯一标识一个传感器设备类型。详见{@link SensorTypeTag}。 + * @param sensorId 唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 @@ -92,12 +91,12 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Disable)(int32_t sensorId); + int32_t (*Disable)([in] int32_t sensorId); /** * @brief 设置指定传感器的数据采样间隔和数据上报间隔。 * - * @param sensorId 唯一标识一个传感器设备类型。详见{@link SensorTypeTag}。 + * @param sensorId 唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 * @param samplingInterval 设置指定传感器的数据采样间隔，单位纳秒。 * @param reportInterval 表示传感器数据上报间隔，单位纳秒。 * @@ -107,13 +106,13 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*SetBatch)(int32_t sensorId, int64_t samplingInterval, int64_t reportInterval); + int32_t (*SetBatch)([in] int32_t sensorId, [in] int64_t samplingInterval, [in] int64_t reportInterval); /** * @brief 设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。 * - * @param sensorId 唯一标识一个传感器设备类型。详见{@link SensorTypeTag}。 - * @param mode 传感器的数据上报模式。详见{@link SensorModeType}。 + * @param sensorId 唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 + * @param mode 传感器的数据上报模式，详见{@link SensorModeType}。 * * @return 如果设置传感器数据报告模式成功，则返回0。 * @return 如果设置传感器数据报告模式失败，则返回负数。 @@ -121,13 +120,13 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*SetMode)(int32_t sensorId, int32_t mode); + int32_t (*SetMode)([in] int32_t sensorId, [in] int32_t mode); /** - * @brief 设置指定传感器量程，精度等可选配置。 + * @brief 设置指定传感器量程、精度等可选配置。 * - * @param sensorId 唯一标识一个传感器设备类型。详见{@link SensorTypeTag}。 - * @param option 传感器的量程，精度等配置。 + * @param sensorId 唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 + * @param option 传感器的量程、精度等配置。 * * @return 如果设置参数成功，则返回0。 * @return 如果设置参数失败，则返回负数。 @@ -135,16 +134,15 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*SetOption)(int32_t sensorId, uint32_t option); + int32_t (*SetOption)([in] int32_t sensorId, [in] uint32_t option); /** * @brief 订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。 * * @param groupId 传感器组ID。 - * sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 - - * sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，并且订阅成功一次。 - * @param cb 要注册的回调函数。详见{@link RecordDataCallback}。 + * sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。 + * sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 + * @param cb 要注册的回调函数，详见{@link RecordDataCallback}。 * * @return 如果注册回调函数成功，则返回0。 * @return 如果注册回调函数失败，则返回负数。 @@ -152,7 +150,7 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Register)(int32_t groupId, RecordDataCallback cb); + int32_t (*Register)([in] int32_t groupId, [in] RecordDataCallback cb); /** * @brief 订阅者去注册传感器数据回调函数。 @@ -160,7 +158,7 @@ struct SensorInterface { * @param groupId 传感器组ID。 * sensorId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。 * sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 - * @param cb 要注册的回调函数。详见{@link RecordDataCallback}。 + * @param cb 要注册的回调函数，详见{@link RecordDataCallback}。 * * @return 如果取消注册回调函数成功，则返回0。 * @return 如果取消注册回调函数失败，则返回负数。 @@ -168,16 +166,14 @@ struct SensorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Unregister)(int32_t groupId, RecordDataCallback cb); + int32_t (*Unregister)([in] int32_t groupId, [in] RecordDataCallback cb); }; /** * @brief 创建传感器接口实例。 * - * @param sensorId 表示传感器ID。有关详细信息，请参阅{@link SensorTypeTag}。 - * 可以使用该实例获取传感器信息，订阅或取消订阅传感器数据，打开或关闭传感器， - * 设置传感器数据报告模式，并设置传感器参数，如精度和测量范围。 - * @param cb 表示要注册的回调函数。有关详细信息，请参阅{@link RecordDataCallback}。 + * @param sensorId 表示传感器ID。有关详细信息，详见{@link SensorTypeTag}。 + * @param cb 表示要注册的回调函数。有关详细信息，详见{@link RecordDataCallback}。 * * @return 如果创建实例成功，则返回非零值。 * @return 如果创建实例失败，则返回负值。 diff --git a/zh-cn/device_api/sensor/sensor_type.h b/zh-cn/device_api/hdi/sensor/sensor_type.h similarity index 66% rename from zh-cn/device_api/sensor/sensor_type.h rename to zh-cn/device_api/hdi/sensor/sensor_type.h index 4cfeb65d..f30154f6 100644 --- a/zh-cn/device_api/sensor/sensor_type.h +++ b/zh-cn/device_api/hdi/sensor/sensor_type.h @@ -14,14 +14,14 @@ */ /** - * @addtogroup 传感器 + * @addtogroup Sensor * @{ * * @brief 传感器设备驱动对传感器服务提供通用的接口能力。 * * 模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， * 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/去订阅传感器数据、 - * 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置等。 + * 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。 * * @version 1.0 */ @@ -46,9 +46,9 @@ extern "C" { #endif #endif /* __cplusplus */ -/**< 传感器名称的最大长度 */ +/**< 传感器名称的最大长度。 */ #define SENSOR_NAME_MAX_LEN 32 -/**< 传感器版本的最大长度 */ +/**< 传感器版本的最大长度。 */ #define SENSOR_VERSION_MAX_LEN 16 /** @@ -57,17 +57,17 @@ extern "C" { * @since 2.2 */ enum SensorStatus { - /**< 传感器执行成功 */ + /**< 传感器执行成功。 */ SENSOR_SUCCESS = 0, - /**< 传感器执行失败 */ + /**< 传感器执行失败。 */ SENSOR_FAILURE = -1, - /**< 传感器不支持 */ + /**< 传感器不支持。 */ SENSOR_NOT_SUPPORT = -2, - /**< 传感器无效参数 */ + /**< 传感器无效参数。 */ SENSOR_INVALID_PARAM = -3, - /**< 传感器无效服务 */ + /**< 传感器无效服务。 */ SENSOR_INVALID_SERVICE = -4, - /**< 传感器空指针 */ + /**< 传感器空指针。 */ SENSOR_NULL_PTR = -5, }; @@ -77,73 +77,73 @@ enum SensorStatus { * @since 2.2 */ enum SensorTypeTag { - /**< 空传感器类型，用于测试 */ + /**< 空传感器类型，用于测试。 */ SENSOR_TYPE_NONE = 0, - /**< 加速度传感器 */ + /**< 加速度传感器。 */ SENSOR_TYPE_ACCELEROMETER = 1, - /**< 陀螺仪传感器 */ + /**< 陀螺仪传感器。 */ SENSOR_TYPE_GYROSCOPE = 2, - /**< 心率传感器 */ + /**< 心率传感器。 */ SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3, - /**< 心电传感器 */ + /**< 心电传感器。 */ SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, - /**< 环境光传感器 */ + /**< 环境光传感器。 */ SENSOR_TYPE_AMBIENT_LIGHT = 5, - /**< 地磁传感器 */ + /**< 地磁传感器。 */ SENSOR_TYPE_MAGNETIC_FIELD = 6, - /**< 电容传感器 */ + /**< 电容传感器。 */ SENSOR_TYPE_CAPACITIVE = 7, - /**< 气压计传感器 */ + /**< 气压计传感器。 */ SENSOR_TYPE_BAROMETER = 8, - /**< 温度传感器 */ + /**< 温度传感器。 */ SENSOR_TYPE_TEMPERATURE = 9, - /**< 霍尔传感器 */ + /**< 霍尔传感器。 */ SENSOR_TYPE_HALL = 10, - /**< 手势传感器 */ + /**< 手势传感器。 */ SENSOR_TYPE_GESTURE = 11, - /**< 接近光传感器 */ + /**< 接近光传感器。 */ SENSOR_TYPE_PROXIMITY = 12, - /**< 湿度传感器 */ + /**< 湿度传感器。 */ SENSOR_TYPE_HUMIDITY = 13, - /**< 医疗传感器ID枚举值范围的开始 */ + /**< 医疗传感器ID枚举值范围的开始。 */ SENSOR_TYPE_MEDICAL_BEGIN = 128, - /**< 医疗传感器ID枚举值范围的结束 */ + /**< 医疗传感器ID枚举值范围的结束。 */ SENSOR_TYPE_MEDICAL_END = 160, - /**< 物理传感器最大类型 */ + /**< 物理传感器最大类型。 */ SENSOR_TYPE_PHYSICAL_MAX = 255, - /**< 方向传感器 */ + /**< 方向传感器。 */ SENSOR_TYPE_ORIENTATION = 256, - /**< 重力传感器 */ + /**< 重力传感器。 */ SENSOR_TYPE_GRAVITY = 257, - /**< 线性加速度传感器 */ + /**< 线性加速度传感器。 */ SENSOR_TYPE_LINEAR_ACCELERATION = 258, - /**< 旋转矢量传感器 */ + /**< 旋转矢量传感器。 */ SENSOR_TYPE_ROTATION_VECTOR = 259, /**< 环境温度传感器 */ SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, - /**< 未校准磁场传感器 */ + /**< 未校准磁场传感器。 */ SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, - /**< 游戏旋转矢量传感器 */ + /**< 游戏旋转矢量传感器。 */ SENSOR_TYPE_GAME_ROTATION_VECTOR = 262, - /**< 未校准陀螺仪传感器 */ + /**< 未校准陀螺仪传感器。 */ SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, - /**< 大幅度动作传感器 */ + /**< 大幅度动作传感器。 */ SENSOR_TYPE_SIGNIFICANT_MOTION = 264, - /**< 计步器检测传感器 */ + /**< 计步器检测传感器。 */ SENSOR_TYPE_PEDOMETER_DETECTION = 265, - /**< 计步器传感器 */ + /**< 计步器传感器。 */ SENSOR_TYPE_PEDOMETER = 266, - /**< 地磁旋转矢量传感器 */ + /**< 地磁旋转矢量传感器。 */ SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, - /**< 心率传感器 */ + /**< 心率传感器。 */ SENSOR_TYPE_HEART_RATE = 278, - /**< 设备方向传感器 */ + /**< 设备方向传感器。 */ SENSOR_TYPE_DEVICE_ORIENTATION = 279, - /**< 佩戴检测传感器 */ + /**< 佩戴检测传感器。 */ SENSOR_TYPE_WEAR_DETECTION = 280, - /**< 未校准加速度传感器 */ + /**< 未校准加速度传感器。 */ SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, - /**< 传感器类型最大个数标r */ + /**< 传感器类型最大个数标r。 */ SENSOR_TYPE_MAX, }; @@ -153,15 +153,15 @@ enum SensorTypeTag { * @since 2.2 */ enum SensorAccuracyType { - /**< 无精度类型 */ + /**< 无精度类型。 */ SENSOR_NO_ACCURACY = 0, - /**< 低精度类型 */ + /**< 低精度类型。 */ SENSOR_LOW_ACCURACY = 1, - /**< 中等精度类型 */ + /**< 中等精度类型。 */ SENSOR_MEDIUM_ACCURACY = 2, - /**< 高精度类型 */ + /**< 高精度类型。 */ SENSOR_HIGH_ACCURACY = 3, - /**< 最大精度类型 */ + /**< 最大精度类型。 */ SENSOR_MAX_ACCURACY, }; @@ -171,13 +171,13 @@ enum SensorAccuracyType { * @since 2.2 */ enum SensorRangeType { - /**< 量程级别1 */ + /**< 量程级别1。 */ SENSOR_RANGE_LEVEL1 = 0, - /**< 量程级别2 */ + /**< 量程级别2。 */ SENSOR_RANGE_LEVEL2 = 1, - /**< 量程级别3 */ + /**< 量程级别3。 */ SENSOR_RANGE_LEVEL3 = 2, - /**< 量程最大级别 */ + /**< 量程最大级别。 */ SENSOR_RANGE_LEVEL_MAX, }; @@ -187,17 +187,17 @@ enum SensorRangeType { * @since 2.2 */ enum SensorModeType { - /**< 传感器默认工作模式状态 */ + /**< 传感器默认工作模式状态。 */ SENSOR_MODE_DEFAULT = 0, - /**< 传感器实时工作模式状态，一组数据上报一次 */ + /**< 传感器实时工作模式状态，一组数据上报一次。 */ SENSOR_MODE_REALTIME = 1, - /**< 传感器实时工作模式状态，状态变更上报一次 */ + /**< 传感器实时工作模式状态，状态变更上报一次。 */ SENSOR_MODE_ON_CHANGE = 2, - /**< 传感器实时工作模式状态，只上报一次 */ + /**< 传感器实时工作模式状态，只上报一次。 */ SENSOR_MODE_ONE_SHOT = 3, - /**< 传感器缓存工作模式状态，根据配置的缓存大小上报 */ + /**< 传感器缓存工作模式状态，根据配置的缓存大小上报。 */ SENSOR_MODE_FIFO_MODE = 4, - /**< 传感器最大类型标识 */ + /**< 传感器最大类型标识。 */ SENSOR_MODE_MAX, }; @@ -207,11 +207,11 @@ enum SensorModeType { * @since 2.2 */ enum SensorGroupType { - /** 传统传感器类型，传感器ID枚举值范围为128-160 */ + /** 传统传感器类型，传感器ID枚举值范围为128-160。 */ TRADITIONAL_SENSOR_TYPE = 0, - /** 医疗传感器类型，传感器ID枚举值范围不在128-160之间 */ + /** 医疗传感器类型，传感器ID枚举值范围不在128-160之间。 */ MEDICAL_SENSOR_TYPE = 1, - /** 最大传感器类型 */ + /** 最大传感器类型。 */ SENSOR_GROUP_TYPE_MAX, }; @@ -223,53 +223,53 @@ enum SensorGroupType { * @since 2.2 */ struct SensorInformation { - /**< 传感器名称 */ + /**< 传感器名称。 */ char sensorName[SENSOR_NAME_MAX_LEN]; - /**< 传感器设备厂商 */ + /**< 传感器设备厂商。*/ char vendorName[SENSOR_NAME_MAX_LEN]; - /**< 传感器固件版本号 */ + /**< 传感器固件版本号。 */ char firmwareVersion[SENSOR_VERSION_MAX_LEN]; /**< 传感器硬件版本号 */ char hardwareVersion[SENSOR_VERSION_MAX_LEN]; - /**< 传感器类型编号，唯一标识一个传感器设备类型，详见{@link SensorTypeTag} */ + /**< 传感器类型编号，唯一标识一个传感器设备类型，详见{@link SensorTypeTag}。 */ int32_t sensorTypeId; - /**< 传感器的标识号，有传感器驱动开发者定义 */ + /**< 传感器的标识号，有传感器驱动开发者定义。 */ int32_t sensorId; - /**< 传感器的最大量程 */ + /**< 传感器的最大量程。 */ float maxRange; - /**< 传感器的精度 */ + /**< 传感器的精度。 */ float accuracy; - /**< 传感器的功耗 */ + /**< 传感器的功耗。 */ float power; }; /** - * @brief 上报传感器数据结构。。 + * @brief 上报传感器数据结构。 * * 上报传感器设备数据事件信息包括传感器的标识号、传感器算法版本号、传感器数据生成时间、传感器量程精度可选配置、传感器工作模式、传感器数据地址、传感器数据长度。 * * @since 2.2 */ struct SensorEvents { - /**< 传感器的标识号 */ + /**< 传感器的标识号。 */ int32_t sensorId; - /**< 传感器算法版本号 */ + /**< 传感器算法版本号。 */ int32_t version; - /**< 传感器数据生成时间 */ + /**< 传感器数据生成时间。 */ int64_t timestamp; - /**< 传感器量程精度可选配置 */ + /**< 传感器量程精度可选配置。 */ uint32_t option; - /**< 传感器工作模式 */ + /**< 传感器工作模式。 */ int32_t mode; - /**< 传感器数据地址 */ + /**< 传感器数据地址。 */ uint8_t *data; - /**< 传感器数据长度 */ + /**< 传感器数据长度。 */ uint32_t dataLen; }; /** * @brief 传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， - * 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，{@link SensorInterface}。 + * 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见{@link SensorInterface}。 * * @since 2.2 */ diff --git a/zh-cn/device_api/vibrator/vibrator_if.h b/zh-cn/device_api/hdi/vibrator/vibrator_if.h similarity index 87% rename from zh-cn/device_api/vibrator/vibrator_if.h rename to zh-cn/device_api/hdi/vibrator/vibrator_if.h index 27d13bd1..fc95c6b3 100644 --- a/zh-cn/device_api/vibrator/vibrator_if.h +++ b/zh-cn/device_api/hdi/vibrator/vibrator_if.h @@ -14,7 +14,7 @@ */ /** - * @addtogroup 马达 + * @addtogroup Vibrator * @{ * * @brief 马达驱动对马达服务提供通用的接口能力。 @@ -60,7 +60,7 @@ struct VibratorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*StartOnce)(uint32_t duration); + int32_t (*StartOnce)([in] uint32_t duration); /** * @brief 控制马达以预置效果执行周期性振动。 @@ -75,14 +75,14 @@ struct VibratorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Start)(const char *effectType); + int32_t (*Start)([in] const char *effectType); /** * @brief 停止马达振动。 * - * 马达启动前，必须在任何模式下停止振动。此功能可在振动过程之后。 + * 马达启动前，必须在任何模式下停止振动。此功能用在振动过程之后。 * - * @param mode 指示振动模式，可以是一次性或周期性的。详见{@link VibratorMode}。 + * @param mode 指示振动模式，可以是一次性或周期性的，详见{@link VibratorMode}。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 @@ -90,7 +90,7 @@ struct VibratorInterface { * @since 2.2 * @version 1.0 */ - int32_t (*Stop)(enum VibratorMode mode); + int32_t (*Stop)([in] enum VibratorMode mode); }; /** @@ -107,7 +107,7 @@ struct VibratorInterface { const struct VibratorInterface *NewVibratorInterfaceInstance(void); /** - * @brief 释放VibratorInterface实例以及释放相关资源。 + * @brief 释放VibratorInterface实例以及相关资源。 * * @return 如果操作成功，则返回0。 * @return 如果操作失败，则返回负值。 diff --git a/zh-cn/device_api/vibrator/vibrator_type.h b/zh-cn/device_api/hdi/vibrator/vibrator_type.h similarity index 91% rename from zh-cn/device_api/vibrator/vibrator_type.h rename to zh-cn/device_api/hdi/vibrator/vibrator_type.h index e6fd7269..f057470f 100644 --- a/zh-cn/device_api/vibrator/vibrator_type.h +++ b/zh-cn/device_api/hdi/vibrator/vibrator_type.h @@ -14,7 +14,7 @@ */ /** - * @addtogroup 马达 + * @addtogroup Vibrator * @{ * * @brief 马达驱动对马达服务提供通用的接口能力。 @@ -53,7 +53,7 @@ extern "C" { enum VibratorMode { /** 表示给定持续时间内的一次性振动。 */ VIBRATOR_MODE_ONCE = 0, - /** 表示具有预置效果的周期性振动 */ + /** 表示具有预置效果的周期性振动。 */ VIBRATOR_MODE_PRESET = 1, /** 表示效果模式无效。 */ VIBRATOR_MODE_BUTT -- Gitee