diff --git a/en/device_api/vibrator/vibrator_if.h b/en/device_api/vibrator/vibrator_if.h index 16f1b5502f611842a5f36eca6b7f0171644a4a37..543acb68734e264404248a53795877504edab0be 100644 --- a/en/device_api/vibrator/vibrator_if.h +++ b/en/device_api/vibrator/vibrator_if.h @@ -17,10 +17,10 @@ * @addtogroup Vibrator * @{ * - * @brief Provides a driver for upper-layer vibrator services. + * @brief Provides APIs for vibrator services to access the vibrator driver. * * After obtaining a driver object or agent, a vibrator service starts or stops the vibrator - * using the functions provided by the driver object or agent. + * using the APIs provided by the driver object or agent. * * @since 2.2 */ @@ -28,8 +28,7 @@ /** * @file vibrator_if.h * - * @brief Declares common APIs in the vibrator module. The APIs can be used to control - * the vibrator to perform a one-shot or periodic vibration. + * @brief Defines the vibrator data structure, including the vibration mode and effect type. * * @since 2.2 * @version 1.0 @@ -51,8 +50,8 @@ struct VibratorInterface { /** * @brief Controls the vibrator to perform a one-shot vibration that lasts for a given duration. * - * One-shot vibration is mutually exclusive with periodic vibration. Before using one-shot vibration, - * exit periodic vibration. + * One-shot vibrations are mutually exclusive with periodic vibrations. Before using the one-shot vibration, + * exit the periodic vibration. * * @param duration Indicates the duration that the one-shot vibration lasts, in milliseconds. * @@ -67,11 +66,10 @@ struct VibratorInterface { /** * @brief Controls the vibrator to perform a periodic vibration with the preset effect. * - * One-shot vibration is mutually exclusive with periodic vibration. Before using periodic vibration, - * exit one-shot vibration. + * One-shot vibrations are mutually exclusive with periodic vibrations. Before using the periodic vibration, + * exit the one-shot vibration. * - * @param effectType Indicates the pointer to the preset effect type. It is recommended that the - * maximum length be 64 bytes. + * @param effectType Indicates the pointer to the preset effect type. * * @return Returns 0 if the operation is successful. * @return Returns a negative value if the operation fails. diff --git a/en/device_api/vibrator/vibrator_type.h b/en/device_api/vibrator/vibrator_type.h index d541228f8e452341e7150a035e836c0d838739d3..d06040e6ca6dfdde497384bb25670091eadbf4dd 100644 --- a/en/device_api/vibrator/vibrator_type.h +++ b/en/device_api/vibrator/vibrator_type.h @@ -17,10 +17,10 @@ * @addtogroup Vibrator * @{ * - * @brief Provides unified APIs for vibrator services to access the vibrator driver. + * @brief Provides APIs for vibrator services to access the vibrator driver. * * After obtaining a driver object or agent, a vibrator service starts or stops the vibrator - * using the functions provided by the driver object or agent. + * using the APIs provided by the driver object or agent. * * @version 1.0 */ @@ -51,11 +51,11 @@ extern "C" { * @since 2.2 */ enum VibratorMode { - /** Indicates the one-shot vibration with the given duration. */ + /** A one-shot vibration with the given duration */ VIBRATOR_MODE_ONCE = 0, - /** Indicates the periodic vibration with the preset effect. */ + /** A periodic vibration with the preset effect */ VIBRATOR_MODE_PRESET = 1, - /** Indicates invalid the effect mode. */ + /** Effect mode */ VIBRATOR_MODE_BUTT };