revise js doc

Signed-off-by: luoying_ace_admin <luoying19@huawei.com>
This commit is contained in:
luoying_ace_admin 2022-11-30 12:10:11 +08:00
parent cb7f939845
commit 55900316f4
11 changed files with 21 additions and 36 deletions

View File

@ -640,7 +640,7 @@ declare class CanvasRenderer extends CanvasPath {
* Provides filter effects such as blur and grayscale. You can set the following filter effects:
* blur(<length>): Adds a Gaussian blur effect to the drawing
* brightness(<percentage>): Provides a linear multiplication for the drawing and adjusts the brightness level.
* contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely blacked out.
* contrast(<percentage>): Adjusts the contrast of the image. When the value is 0%, the image is completely black.
* When the value is 100%, there is no change in the image.
* drop-shadow(<offset-x>, <offset-y>, <blur-radius>, <spread-radius>, <color>): Shading Drawings
* --- <offset-x>: Describes the horizontal distance of the shadow.
@ -648,7 +648,7 @@ declare class CanvasRenderer extends CanvasPath {
* --- <blur-radius>: Blur radius. The larger the value, the greater the blur. The value cannot be a negative number.
* --- <spread-radius>: Positive numbers make the shadow expand larger, negative numbers make the shadow shrink.
* --- <color>: Shadow Color
* grayscale(<percentage>)Converts the image to a gray image. When the value is 100%, the image is completely grayed out.
* grayscale(<percentage>)Converts the image to a gray image. When the value is 100%, the image is completely gray.
* When the value is 0%, there is no change in the image.
* hue-rotate(<degree>)Perform color rotation on an image. When the value is 0 degrees, there is no change in the image.
* invert(<percentage>)Inverted image (representing the effect of a photographic negative). When the value is 100%,

View File

@ -19,7 +19,7 @@
*/
interface ImageAnimatorInterface {
/**
* ImageAimator is returned.
* ImageAnimator is returned.
* @since 7
*/
(): ImageAnimatorAttribute;

View File

@ -90,7 +90,7 @@ declare enum NavBarPosition {
}
/**
* Naivagtion title mode.
* Navigation title mode.
* @since 8
*/
declare enum NavigationTitleMode {

View File

@ -65,7 +65,6 @@ declare class Storage {
* Constructor parameters.
* @since 7
* @systemapi
* @hide
*/
constructor(needCrossThread?: boolean, file?: string);
@ -73,7 +72,6 @@ declare class Storage {
* Called when data is obtained.
* @since 7
* @systemapi
* @hide
*/
get(key: string): string | undefined;
@ -81,7 +79,6 @@ declare class Storage {
* Called when setting.
* @since 7
* @systemapi
* @hide
*/
set(key: string, val: any): void;
@ -89,7 +86,6 @@ declare class Storage {
* Called when data is cleared.
* @since 7
* @systemapi
* @hide
*/
clear(): void;
@ -97,7 +93,6 @@ declare class Storage {
* Called when data is deleted.
* @since 7
* @systemapi
* @hide
*/
delete(key: string): void;
}

View File

@ -158,7 +158,7 @@ export interface AnimatorResult {
reverse(): void;
/**
* Trigger when vsync callback.
* @param { number } progress - The current progress of animtion
* @param { number } progress - The current progress of animation
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
*/
@ -187,7 +187,6 @@ export interface AnimatorResult {
* Defines the Animator class.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 6
* @import prompt from '@ohos.animator';
*/
export default class Animator {
/**

View File

@ -135,7 +135,7 @@ declare namespace matrix4 {
* Copy function of Matrix, which can copy a copy of the current matrix object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
copy(): Matrix4Transit;
@ -143,7 +143,7 @@ declare namespace matrix4 {
* The inverse function of Matrix returns an inverse matrix of the current matrix object, that is, the effect is exactly the opposite.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
invert(): Matrix4Transit;
@ -151,7 +151,7 @@ declare namespace matrix4 {
* Matrix superposition function, which can superpose the effects of two matrices to generate a new matrix object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
combine(options: Matrix4Transit): Matrix4Transit;
@ -159,7 +159,7 @@ declare namespace matrix4 {
* Matrix translation function, which can add the x-axis, Y-axis, or Z-axis translation effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
translate(options: TranslateOption): Matrix4Transit;
@ -167,7 +167,7 @@ declare namespace matrix4 {
* Scaling function of the Matrix, which can add the x-axis, Y-axis, or Z-axis scaling effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
scale(options: ScaleOption): Matrix4Transit;
@ -175,7 +175,7 @@ declare namespace matrix4 {
* Rotation function of the Matrix. You can add the x-axis, Y-axis, or Z-axis rotation effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
rotate(options: RotateOption): Matrix4Transit;
@ -183,7 +183,7 @@ declare namespace matrix4 {
* Matrix coordinate point conversion function, which can apply the current transformation effect to a coordinate point.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
transformPoint(options: [number, number]): [number, number];
}
@ -192,7 +192,7 @@ declare namespace matrix4 {
* Constructor of Matrix, which can create a fourth-order matrix based on the input parameters. The matrix is column-first.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function init(
options: [
@ -219,7 +219,7 @@ declare namespace matrix4 {
* Matrix initialization function, which can return an identity matrix object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function identity(): Matrix4Transit;
@ -227,7 +227,7 @@ declare namespace matrix4 {
* Copy function of Matrix, which can copy a copy of the current matrix object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function copy(): Matrix4Transit;
@ -235,7 +235,7 @@ declare namespace matrix4 {
* The inverse function of Matrix returns an inverse matrix of the current matrix object, that is, the effect is exactly the opposite.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function invert(): Matrix4Transit;
@ -243,7 +243,7 @@ declare namespace matrix4 {
* Matrix superposition function, which can superpose the effects of two matrices to generate a new matrix object.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function combine(options: Matrix4Transit): Matrix4Transit;
@ -251,7 +251,7 @@ declare namespace matrix4 {
* Matrix translation function, which can add the x-axis, Y-axis, or Z-axis translation effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function translate(options: TranslateOption): Matrix4Transit;
@ -259,7 +259,7 @@ declare namespace matrix4 {
* Scaling function of the Matrix, which can add the x-axis, Y-axis, or Z-axis scaling effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function scale(options: ScaleOption): Matrix4Transit;
@ -267,7 +267,7 @@ declare namespace matrix4 {
* Rotation function of the Matrix. You can add the x-axis, Y-axis, or Z-axis rotation effect to the current matrix.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function rotate(options: RotateOption): Matrix4Transit;
@ -275,7 +275,7 @@ declare namespace matrix4 {
* Matrix coordinate point conversion function, which can apply the current transformation effect to a coordinate point.
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
* @return Return to Matrix4Transit
* @returns Return to Matrix4Transit
*/
function transformPoint(options: [number, number]): [number, number];
}

View File

@ -17,7 +17,6 @@ import {Callback} from './basic';
/**
* Used to do mediaquery operations.
* @import import mediaquery from '@ohos.mediaquery'
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 7
*/

View File

@ -21,7 +21,6 @@ import { Resource } from 'GlobalResource';
/**
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
* @import prompt from '@ohos.prompt';
* @deprecated since 9
* @useinstead ohos.promptAction
*/

View File

@ -20,7 +20,6 @@ import { AsyncCallback } from './basic';
* @namespace router
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @since 8
* @import router from '@ohos.router';
*/
declare namespace router {

View File

@ -2859,21 +2859,18 @@ export interface Options<T extends ViewModel, Data = DefaultData<T>> {
/**
* Used for ide.
* @systemapi
* @hide
* @since 4
*/
type DefaultData<T> = object;
/**
* Used for ide.
* @systemapi
* @hide
* @since 4
*/
type CombinedOptions<T extends ViewModel, Data> = object & Options<T, Data> & ThisType<T & ViewModel & Data>;
/**
* @syscap SystemCapability.ArkUI.ArkUI.Full
* @systemapi
* @hide
* @since 4
*/
export declare function extendViewModel<T extends ViewModel, Data>(options: CombinedOptions<T, Data>): ViewModel & Data;

View File

@ -112,7 +112,6 @@ export interface Options<T extends ViewModel, Data = DefaultData<T>> {
/**
* Used for ide.
* @systemapi
* @hide
* @since 4
*/
type DefaultData<T> = object;
@ -120,7 +119,6 @@ type DefaultData<T> = object;
/**
* Used for ide.
* @systemapi
* @hide
* @since 4
*/
type CombinedOptions<T extends ViewModel, Data> = object &
@ -130,7 +128,6 @@ type CombinedOptions<T extends ViewModel, Data> = object &
/**
* @syscap SystemCapability.ArkUI.ArkUI.Lite
* @systemapi
* @hide
* @since 4
*/
export declare function extendViewModel<T extends ViewModel, Data>(