docs: add JSDoc @type tag to config (#6272) [ci skip]

Add JSDoc: @type for better editor support. https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
vuejs · Feb 9, 2021 · fb2205d · fb2205d
1 parent e910e9c
commit fb2205d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/config/README.md b/docs/config/README.md
@@ -22,6 +22,10 @@ The file should export an object containing options:
 
 ``` js
 // vue.config.js
+
+/**
+ * @type {import('@vue/cli-service').ProjectOptions}
+ */
 module.exports = {
   // options...
 }

diff --git a/docs/ru/config/README.md b/docs/ru/config/README.md
@@ -22,6 +22,10 @@ sidebar: auto
 
 ```js
 // vue.config.js
+
+/**
+ * @type {import('@vue/cli-service').ProjectOptions}
+ */
 module.exports = {
   // настройки...
 }

diff --git a/docs/zh/config/README.md b/docs/zh/config/README.md
@@ -22,6 +22,10 @@ sidebar: auto
 
 ``` js
 // vue.config.js
+
+/**
+ * @type {import('@vue/cli-service').ProjectOptions}
+ */
 module.exports = {
   // 选项...
 }