chore: avoid api-extractor warnings

diff --git a/api-extractor.json b/api-extractor.json
index 883bf47a3ae59e23db0a1d2673653159e79a3837..bf3e80961a90b56e55fedb841980fd4cb59e820b 100644 (file)
--- a/api-extractor.json
+++ b/api-extractor.json
@@ -44,6 +44,22 @@
 
       "tsdoc-undefined-tag": {
         "logLevel": "none"
+      },
+
+      "tsdoc-escape-greater-than": {
+        "logLevel": "none"
+      },
+
+      "tsdoc-malformed-inline-tag": {
+        "logLevel": "none"
+      },
+
+      "tsdoc-escape-right-brace": {
+        "logLevel": "none"
+      },
+
+      "tsdoc-unnecessary-backslash": {
+        "logLevel": "none"
       }
     }
   }

diff --git a/packages/runtime-core/src/apiCreateApp.ts b/packages/runtime-core/src/apiCreateApp.ts
index b77c90c3448414c653c60ea78256dca9c9fa73ff..ae2f58418dce7d2f333a3ca0fc90b875e56e621a 100644 (file)
--- a/packages/runtime-core/src/apiCreateApp.ts
+++ b/packages/runtime-core/src/apiCreateApp.ts
@@ -83,7 +83,7 @@ export interface AppConfig {
   ) => void
 
   /**
-   * Options to pass to @vue/compiler-dom.
+   * Options to pass to `@vue/compiler-dom`.
    * Only supported in runtime compiler build.
    */
   compilerOptions: RuntimeCompilerOptions

diff --git a/packages/runtime-core/src/compat/global.ts b/packages/runtime-core/src/compat/global.ts
index e0c847d33ae4a3296e43291604f2676da4ebb10b..10a258638270951d5f275434f95ee33920e28524 100644 (file)
--- a/packages/runtime-core/src/compat/global.ts
+++ b/packages/runtime-core/src/compat/global.ts
@@ -88,7 +88,7 @@ export type CompatVue = Pick<App, 'version' | 'component' | 'directive'> & {
   compile(template: string): RenderFunction
 
   /**
-   * @deprecated
+   * @deprecated Vue 3 no longer supports extending constructors.
    */
   extend: (options?: ComponentOptions) => CompatVue
   /**

diff --git a/packages/shared/src/domAttrConfig.ts b/packages/shared/src/domAttrConfig.ts
index 46607c55b0792981094cf4f866b516c181a826ab..fb4f29a46fca0757069f9f401d2fb63289a56cf0 100644 (file)
--- a/packages/shared/src/domAttrConfig.ts
+++ b/packages/shared/src/domAttrConfig.ts
@@ -26,7 +26,7 @@ export const isBooleanAttr = /*#__PURE__*/ makeMap(
 
 /**
  * Boolean attributes should be included if the value is truthy or ''.
- * e.g. <select multiple> compiles to { multiple: '' }
+ * e.g. `<select multiple>` compiles to `{ multiple: '' }`
  */
 export function includeBooleanAttr(value: unknown): boolean {
   return !!value || value === ''

diff --git a/packages/shared/src/patchFlags.ts b/packages/shared/src/patchFlags.ts
index 1025258df2f85ee374582fcdc9d43effb1cbaac5..8a5ca2faada510211f7778afbe9ae609ddc6868f 100644 (file)
--- a/packages/shared/src/patchFlags.ts
+++ b/packages/shared/src/patchFlags.ts
@@ -31,9 +31,12 @@ export const enum PatchFlags {
    * Indicates an element with dynamic style
    * The compiler pre-compiles static string styles into static objects
    * + detects and hoists inline static objects
-   * e.g. style="color: red" and :style="{ color: 'red' }" both get hoisted as
-   *   const style = { color: 'red' }
-   *   render() { return e('div', { style }) }
+   * e.g. `style="color: red"` and `:style="{ color: 'red' }"` both get hoisted
+   * as:
+   * ```js
+   * const style = { color: 'red' }
+   * render() { return e('div', { style }) }
+   * ```
    */
   STYLE = 1 << 2,