!12529 web api lint告警

Merge pull request !12529 from bigpumpkin/master

api/@internal/component/ets/web.d.ts

@@ -34,6 +34,7 @@
 /**
  * Provides methods for controlling the web controller.
  *
+ * @typedef { import('../api/@ohos.web.webview').default.WebviewController }
  * @syscap SystemCapability.Web.Webview.Core
  * @crossplatform
  * @atomicservice
@@ -44,6 +45,8 @@ declare type WebviewController = import('../api/@ohos.web.webview').default.Webv
 /**
  * The callback of load committed.
  *
+ * @typedef { function } OnNavigationEntryCommittedCallback
+ * @param { LoadCommittedDetails } loadCommittedDetails - callback information of onNavigationEntryCommitted.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 11
@@ -53,7 +56,8 @@ type OnNavigationEntryCommittedCallback = (loadCommittedDetails: LoadCommittedDe
 /**
  * The callback of ssl error event.
  *
- * @typedef OnSslErrorEventCallback
+ * @typedef { function } OnSslErrorEventCallback
+ * @param { SslErrorEvent } sslErrorEvent - callback information of onSslErrorEvent.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -63,7 +67,8 @@ type OnSslErrorEventCallback = (sslErrorEvent: SslErrorEvent) => void;
 /**
  * The callback of largestContentfulPaint.
  *
- * @typedef OnLargestContentfulPaintCallback
+ * @typedef { function } OnLargestContentfulPaintCallback
+ * @param { LargestContentfulPaint } largestContentfulPaint - callback information of onLargestContentfulPaint.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -73,7 +78,8 @@ type OnLargestContentfulPaintCallback = (largestContentfulPaint: LargestContentf
 /**
  * The callback of firstMeaningfulPaint.
  *
- * @typedef OnFirstMeaningfulPaintCallback
+ * @typedef { function } OnFirstMeaningfulPaintCallback
+ * @param { FirstMeaningfulPaint } firstMeaningfulPaint - callback information of onFirstMeaningfulPaint.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -83,8 +89,11 @@ type OnFirstMeaningfulPaintCallback = (firstMeaningfulPaint: FirstMeaningfulPain
 /**
  * The callback of onOverrideUrlLoading.
  * Should not call WebviewController.loadUrl with the request's URL and then return true.
- * Returning true causes the current Web to abort loading the URL, false causes the Web to continue loading the url as usual.
  *
+ * @typedef { function } OnOverrideUrlLoadingCallback
+ * @param { WebResourceRequest } webResourceRequest - callback information of onOverrideUrlLoading.
+ * @returns { boolean } - Returning true causes the current Web to abort loading the URL, 
+ *                        false causes the Web to continue loading the url as usual.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -94,6 +103,8 @@ type OnOverrideUrlLoadingCallback = (webResourceRequest: WebResourceRequest) =>
 /**
  * The callback of Intelligent Tracking Prevention.
  *
+ * @typedef { function } OnIntelligentTrackingPreventionCallback
+ * @param { IntelligentTrackingPreventionDetails } details - callback information of onIntelligentTrackingPrevention.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -133,8 +144,8 @@ declare interface NativeMediaPlayerConfig {
 /**
  * The callback of render process not responding.
  *
- * @typedef {function} OnRenderProcessNotRespondingCallback
- * @param {RenderProcessNotRespondingData} data - details of onRenderProcessNotResponding.
+ * @typedef { function } OnRenderProcessNotRespondingCallback
+ * @param { RenderProcessNotRespondingData } data - details of onRenderProcessNotResponding.
  * @syscap SystemCapability.Web.Webview.Core
  * @since 12
  */
@@ -143,7 +154,7 @@ type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingDa
 /**
  * The callback of render process responding.
  *
- * @typedef {function} OnRenderProcessRespondingCallback
+ * @typedef { function } OnRenderProcessRespondingCallback
  * @syscap SystemCapability.Web.Webview.Core
  * @since 12
  */
@@ -152,8 +163,8 @@ type OnRenderProcessRespondingCallback = () => void;
 /**
 * The callback of ViewportFit Changed.
  *
- * @typedef {function} OnViewportFitChangedCallback
- * @param {ViewportFit} viewportFit - details of OnViewportFitChangedCallback.
+ * @typedef { function } OnViewportFitChangedCallback
+ * @param { ViewportFit } viewportFit - details of OnViewportFitChangedCallback.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -163,7 +174,8 @@ type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void;
 /**
  * The callback of ads block
  *
- * @typedef {function} OnAdsBlockedCallback
+ * @typedef { function } OnAdsBlockedCallback
+ * @param { AdsBlockedDetails } details - details of OnAdsBlockedCallback.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -328,9 +340,9 @@ declare interface WebKeyboardCallbackInfo {
 /**
  * The callback of onInterceptKeyboardAttach event.
  *
- * @typedef {function} WebKeyboardCallback
- * @param {WebKeyboardCallbackInfo} keyboardCallbackInfo - callback information of onInterceptKeyboardAttach.
- * @returns {WebKeyboardOptions} Return the web keyboard options of this web component.
+ * @typedef { function } WebKeyboardCallback
+ * @param { WebKeyboardCallbackInfo } keyboardCallbackInfo - callback information of onInterceptKeyboardAttach.
+ * @returns { WebKeyboardOptions } Return the web keyboard options of this web component.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -500,6 +512,8 @@ declare enum MixedMode {
 /**
  * The callback of safe browsing check.
  *
+ * @typedef { function } OnSafeBrowsingCheckResultCallback
+ * @param { ThreatType } threatType - callback information of onSafeBrowsingCheckResult.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 11
@@ -1043,6 +1057,7 @@ declare interface FullScreenEnterEvent {
   /**
    * A function handle to exit full-screen mode.
    *
+   * @type { FullScreenExitHandler }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -1051,6 +1066,7 @@ declare interface FullScreenEnterEvent {
   /**
    * The intrinsic width of the video if the fullscreen element contains video element, expressed in CSS pixels.
    *
+   * @type { ?number }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -1059,6 +1075,7 @@ declare interface FullScreenEnterEvent {
   /**
    * The intrinsic height of the video if the fullscreen element contains video element, expressed in CSS pixels.
    *
+   * @type { ?number }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -1069,6 +1086,8 @@ declare interface FullScreenEnterEvent {
 /**
  * The callback when the web component enter full screen mode.
  *
+ * @typedef { function } OnFullScreenEnterCallback
+ * @param { FullScreenEnterEvent } event - callback information of onFullScreenEnter.
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 12
@@ -1170,6 +1189,7 @@ declare enum RenderExitReason {
   /**
    * The callback of custom hide of the context menu.
    *
+   * @typedef { function } OnContextMenuHideCallback
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 11
@@ -2470,7 +2490,7 @@ declare enum NativeEmbedStatus {
   DESTROY = 2,
 
   /**
-   * The embed tag enter backforwardcache.
+   * The embed tag enter backforward cache.
    *
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
@@ -2479,7 +2499,7 @@ declare enum NativeEmbedStatus {
   ENTER_BFCACHE = 3,
 
   /**
-   * The embed tag leave backforwardcache.
+   * The embed tag leave backforward cache.
    *
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
@@ -5993,7 +6013,7 @@ declare interface JavaScriptProxy {
   /**
    * The async method of the application side JavaScript object participating in the registration.
    *
-   * @type { Array<string> }
+   * @type { ?Array<string> }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -7791,7 +7811,7 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
   /**
    * Set the default text encodingFormat value of webview. The default value is UTF-8.
    *
-   * @param { string } default text encodingFormat.
+   * @param { string } textEncodingFormat text encodingFormat.
    * @returns { WebAttribute }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
@@ -8459,6 +8479,7 @@ declare class WebAttribute extends CommonMethod<WebAttribute> {
 /**
  * Defines Web Component.
  *
+ * @constant
  * @syscap SystemCapability.Web.Webview.Core
  * @crossplatform
  * @atomicservice
@@ -8475,6 +8496,7 @@ declare const Web: WebInterface;
 /**
  * Defines Web Component instance.
  *
+ * @constant
  * @syscap SystemCapability.Web.Webview.Core
  * @atomicservice
  * @since 11
@@ -8493,6 +8515,7 @@ declare interface SslErrorEvent {
   /**
    * Notifies the user of the operation behavior of the web component.
    *
+   * @type { SslErrorHandler }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -8501,6 +8524,7 @@ declare interface SslErrorEvent {
   /**
    * Error codes.
    *
+   * @type { SslError }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -8509,6 +8533,7 @@ declare interface SslErrorEvent {
   /**
    * Request url.
    *
+   * @type { string }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -8517,6 +8542,7 @@ declare interface SslErrorEvent {
   /**
    * Original url.
    *
+   * @type { string }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -8525,6 +8551,7 @@ declare interface SslErrorEvent {
   /**
    * Referrer.
    *
+   * @type { string }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12
@@ -8533,6 +8560,7 @@ declare interface SslErrorEvent {
   /**
    * Whether the error is fatal.
    *
+   * @type { boolean }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12

api/@ohos.web.webview.d.ts

@@ -97,6 +97,7 @@ declare namespace webview {
      */
     /**
      * Gets the key of the request/response header.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -117,6 +118,7 @@ declare namespace webview {
      */
     /**
      * Gets the value of the request/response header.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -447,6 +449,7 @@ declare namespace webview {
     /**
      * Get the hit test type.
      *
+     * @type { WebHitTestType }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -462,6 +465,7 @@ declare namespace webview {
     /**
      * Get the hit test extra data.
      *
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -503,6 +507,7 @@ declare namespace webview {
     /**
      * Name of the custom scheme.
      *
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -518,6 +523,7 @@ declare namespace webview {
     /**
      * Whether Cross-Origin Resource Sharing is supported.
      *
+     * @type { boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -533,6 +539,7 @@ declare namespace webview {
     /**
      * Whether fetch request is supported.
      *
+     * @type { boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -544,6 +551,7 @@ declare namespace webview {
      * schemes needs to comply with the URL normalization and parsing rules defined in Section 3.1 of RFC 1738,
      * which can be found in the http://www.ietf.org/rfc/rfc1738.txt.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -554,6 +562,7 @@ declare namespace webview {
      * If isLocal is true, the same security rules as those applied to the "file" URL will be
      * used to handle the scheme.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -564,6 +573,7 @@ declare namespace webview {
      * If isDisplayIsolated is true, then the scheme can only be displayed from other content
      * hosted using the same scheme.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -574,6 +584,7 @@ declare namespace webview {
      * If isSecure is true, the same security rules as those applied to the "https" URL will be
      * used to handle the scheme.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -584,6 +595,7 @@ declare namespace webview {
      * If isCspBypassing is true, then this scheme can bypass Content Security Policy (CSP)
      * checks. In most cases, this value should not be true when isStandard is true.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -633,6 +645,7 @@ declare namespace webview {
     /**
      * Url source.
      *
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -647,6 +660,7 @@ declare namespace webview {
     /**
      * Specify the amount of storage for the source.
      *
+     * @type { number }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -661,6 +675,7 @@ declare namespace webview {
     /**
      * the callback of getOriginUsage.
      *
+     * @type { number }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -679,6 +694,7 @@ declare namespace webview {
   interface RequestInfo {
     /**
      * Gets the url of the request.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -687,6 +703,7 @@ declare namespace webview {
 
     /**
      * Gets the method of the request.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -695,6 +712,7 @@ declare namespace webview {
 
     /**
      * Gets the form data of the request.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -1981,6 +1999,7 @@ declare namespace webview {
   /**
    * WebMessage type supplied to {@link onMessageEventExt} for indicating the type of web message.
    *
+   * @typedef { ArrayBuffer | string }
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 11
@@ -2018,6 +2037,7 @@ declare namespace webview {
     /**
      * The flag indicates whether more formats are supported than string and array buffers.
      *
+     * @type { ?boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -2151,6 +2171,7 @@ declare namespace webview {
      */
     /**
      * Pixelmap of icon.
+     * @type { image.PixelMap }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 11
@@ -2164,6 +2185,7 @@ declare namespace webview {
      */
     /**
      * Url of this history item.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -2178,6 +2200,7 @@ declare namespace webview {
      */
     /**
      * Original request url of this history item.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -2192,6 +2215,7 @@ declare namespace webview {
      */
     /**
      * Title of this history item.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -2230,6 +2254,7 @@ declare namespace webview {
      */
     /**
      * Current index in BackForwardList.
+     * @type { number }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -2244,6 +2269,7 @@ declare namespace webview {
      */
     /**
      * Size of in BackForwardList.
+     * @type { number }
      * @syscap SystemCapability.Web.Webview.Core
      * @crossplatform
      * @atomicservice
@@ -2600,6 +2626,7 @@ declare namespace webview {
      * Response headers used to configure the validation key of code cache.
      * Currently only support E-Tag and Last-Modified.
      *
+     * @type { Array<WebHeader> }
      * @syscap SystemCapability.Web.Webview.Core
      * @since 12
      */
@@ -6000,7 +6027,7 @@ declare namespace webview {
     /**
      * Set the response encoding.
      *
-     * @param { string } type - Encoding.
+     * @param { string } encoding - Encoding.
      * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types.
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
@@ -6021,7 +6048,7 @@ declare namespace webview {
      *
      * @param { string } name - Header name.
      * @param { string } value - Header value.
-     * @param { boolean } name - Whether to overwrite.
+     * @param { boolean } overwrite - Whether to overwrite.
      * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.
      * <br>2. Incorrect parameter types.
      * @syscap SystemCapability.Web.Webview.Core
@@ -6659,6 +6686,7 @@ declare namespace webview {
   class MediaSourceInfo {
     /**
      * Source type, most time is URL.
+     * @type { SourceType }
      * @syscap SystemCapability.Web.Webview.Core
      * @since 12
      */
@@ -6666,6 +6694,7 @@ declare namespace webview {
 
     /**
      * Media source, most time is Uri.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6674,6 +6703,7 @@ declare namespace webview {
 
     /**
      * Media format, such as mp4, webm, m3u8 etc.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6733,6 +6763,7 @@ declare namespace webview {
   class NativeMediaPlayerSurfaceInfo {
     /**
      * Id of surface.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6796,6 +6827,7 @@ declare namespace webview {
     embedID: string,
     /**
      * Media type : Video or Audio.
+     * @type { MediaType }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6803,6 +6835,7 @@ declare namespace webview {
     mediaType: MediaType,
     /**
      * Media source list, player should choose an appropriate one to play.
+     * @type { MediaSourceInfo[] }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6810,6 +6843,7 @@ declare namespace webview {
     mediaSrcList: MediaSourceInfo[],
     /**
      * Surface to render media content on.
+     * @type { NativeMediaPlayerSurfaceInfo }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6817,6 +6851,7 @@ declare namespace webview {
     surfaceInfo: NativeMediaPlayerSurfaceInfo,
     /**
      * Should show media controls.
+     * @type { boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6825,6 +6860,7 @@ declare namespace webview {
     /**
      * Limit media controls items.
      *  Such as 'nodownload', 'nofullscreen', 'noremoteplayback'
+     * @type { string[] }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6832,6 +6868,7 @@ declare namespace webview {
     controlList: string[],
     /**
      * Player should be muted;
+     * @type { boolean }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6839,6 +6876,7 @@ declare namespace webview {
     muted: boolean,
     /**
      * Player should show poster before media first frame shown.
+     * @type { string }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6846,6 +6884,7 @@ declare namespace webview {
     posterUrl: string,
     /**
      * Preload type.
+     * @type { Preload }
      * @syscap SystemCapability.Web.Webview.Core
      * @atomicservice
      * @since 12
@@ -6853,12 +6892,14 @@ declare namespace webview {
     preload: Preload,
     /**
      * Header information of a media network request.
+     * @type { Record<string, string> }
      * @syscap SystemCapability.Web.Webview.Core
      * @since 12
      */
     headers: Record<string, string>,
     /**
      * The information list of attributes of media tag.
+     * @type { Record<string, string> }
      * @syscap SystemCapability.Web.Webview.Core
      * @since 12
      */
@@ -6868,6 +6909,10 @@ declare namespace webview {
   /**
    * The callback of creating a native media player.
    *
+   * @typedef { function }
+   * @param { NativeMediaPlayerHandler } handler - callback information of onCreateNativeMediaPlayer.
+   * @param { MediaInfo } mediaInfo - callback information of onCreateNativeMediaPlayer.
+   * @returns { NativeMediaPlayerBridge } Returns whether the app takes over the media.
    * @syscap SystemCapability.Web.Webview.Core
    * @atomicservice
    * @since 12

build-tools/api_check_plugin/plugin/dictionaries_supplementary.txt

@@ -121,6 +121,7 @@ buttonconfig
 bypassed
 bypassing
 bytrace
+backforward
 callbackfn
 camped
 canceling
@@ -850,6 +851,7 @@ rtt
 ruim
 ruleset
 rwt
+resfile
 s5
 sac
 sae
@@ -982,6 +984,7 @@ systemapp
 systembar
 systemsize
 systemui
+suspending
 tailoring
 talkback
 taskmanager