From 30e80f22576ebe8e2f6522ff9da1f7334a274206 Mon Sep 17 00:00:00 2001
From: FairyEver <1711467488@qq.com>
Date: Tue, 20 Aug 2019 22:15:25 +0800
Subject: [PATCH] =?UTF-8?q?=E7=BB=9F=E4=B8=80=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Former-commit-id: 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly 84696fcb55852443b9c60211e9fd1b3cd8610968 [formerly dfcac6903fac04b8506e7590162e5a534f708d3e [formerly a7bee713a1d6b6f6e9c2638ebfdcab241ac98d8d]]]]]
Former-commit-id: 2fd44bb55cb052776b8d13e3619ac467d28cfae5
Former-commit-id: 0b0091d3623441b860ea5ebd5473f940c38dbd5d
Former-commit-id: b7c16508cc73b0e21a998594c641027a15725e97 [formerly c0f4da610591404663be3991a505bb91a154ca24]
Former-commit-id: 6a65b8abd337142301552e8d07ac77fb7ba527a6
Former-commit-id: 3e88bb356257d298419021cc613ec153af7e033e
Former-commit-id: 234c54e019fd3847c06647ae01ba88eac3c38344
Former-commit-id: 6425245ee4e4a5b6fee961f2ea44f51568745b97
Former-commit-id: 930bd2ecd955a8f91fabcd414af1aa628fc61f96
---
 src/libs/util.db.js                           | 28 ++++-----
 src/store/modules/d2admin/modules/account.js  | 14 ++---
 src/store/modules/d2admin/modules/color.js    |  9 +--
 src/store/modules/d2admin/modules/db.js       | 62 +++++++++----------
 .../modules/d2admin/modules/fullscreen.js     |  4 +-
 src/store/modules/d2admin/modules/gray.js     |  4 +-
 src/store/modules/d2admin/modules/log.js      |  7 ++-
 src/store/modules/d2admin/modules/menu.js     | 10 +--
 .../d2admin/modules/page.js.REMOVED.git-id    |  2 +-
 src/store/modules/d2admin/modules/releases.js |  2 +-
 src/store/modules/d2admin/modules/search.js   |  6 +-
 src/store/modules/d2admin/modules/size.js     |  6 +-
 src/store/modules/d2admin/modules/theme.js    |  8 +--
 .../modules/d2admin/modules/transition.js     |  4 +-
 src/store/modules/d2admin/modules/ua.js       |  2 +-
 src/store/modules/d2admin/modules/user.js     |  4 +-
 16 files changed, 88 insertions(+), 84 deletions(-)

diff --git a/src/libs/util.db.js b/src/libs/util.db.js
index e14c64d4..eca7d825 100644
--- a/src/libs/util.db.js
+++ b/src/libs/util.db.js
@@ -17,11 +17,11 @@ export default db
 
 /**
  * @description 检查路径是否存在 不存在的话初始化
- * @param {Object} param dbName {String} 数据库名称
- * @param {Object} param path {String} 路径
- * @param {Object} param user {Boolean} 区分用户
- * @param {Object} param validator {Function} 数据校验钩子 返回 true 表示验证通过
- * @param {Object} param defaultValue {*} 初始化默认值
+ * @param {Object} payload dbName {String} 数据库名称
+ * @param {Object} payload path {String} 路径
+ * @param {Object} payload user {Boolean} 区分用户
+ * @param {Object} payload validator {Function} 数据校验钩子 返回 true 表示验证通过
+ * @param {Object} payload defaultValue {*} 初始化默认值
  * @returns {String} 可以直接使用的路径
  */
 export function pathInit ({
@@ -45,10 +45,10 @@ export function pathInit ({
 /**
  * @description 将数据存储到指定位置 | 路径不存在会自动初始化
  * @description 效果类似于取值 dbName.path = value
- * @param {Object} param dbName {String} 数据库名称
- * @param {Object} param path {String} 存储路径
- * @param {Object} param value {*} 需要存储的值
- * @param {Object} param user {Boolean} 是否区分用户
+ * @param {Object} payload dbName {String} 数据库名称
+ * @param {Object} payload path {String} 存储路径
+ * @param {Object} payload value {*} 需要存储的值
+ * @param {Object} payload user {Boolean} 是否区分用户
  */
 export function dbSet ({
   dbName = 'database',
@@ -66,10 +66,10 @@ export function dbSet ({
 /**
  * @description 获取数据
  * @description 效果类似于取值 dbName.path || defaultValue
- * @param {Object} param dbName {String} 数据库名称
- * @param {Object} param path {String} 存储路径
- * @param {Object} param defaultValue {*} 取值失败的默认值
- * @param {Object} param user {Boolean} 是否区分用户
+ * @param {Object} payload dbName {String} 数据库名称
+ * @param {Object} payload path {String} 存储路径
+ * @param {Object} payload defaultValue {*} 取值失败的默认值
+ * @param {Object} payload user {Boolean} 是否区分用户
  */
 export function dbGet ({
   dbName = 'database',
@@ -89,7 +89,7 @@ export function dbGet ({
 
 /**
  * @description 获取存储数据库对象
- * @param {Object} param user {Boolean} 是否区分用户
+ * @param {Object} payload user {Boolean} 是否区分用户
  */
 export function database ({
   dbName = 'database',
diff --git a/src/store/modules/d2admin/modules/account.js b/src/store/modules/d2admin/modules/account.js
index 8fb4e522..a6203600 100644
--- a/src/store/modules/d2admin/modules/account.js
+++ b/src/store/modules/d2admin/modules/account.js
@@ -8,10 +8,10 @@ export default {
   actions: {
     /**
      * @description 登录
-     * @param {Object} param context
-     * @param {Object} param username {String} 用户账号
-     * @param {Object} param password {String} 密码
-     * @param {Object} param route {Object} 登录成功后定向的路由对象 任何 vue-router 支持的格式
+     * @param {Object} context
+     * @param {Object} payload username {String} 用户账号
+     * @param {Object} payload password {String} 密码
+     * @param {Object} payload route {Object} 登录成功后定向的路由对象 任何 vue-router 支持的格式
      */
     login ({ dispatch }, {
       username = '',
@@ -48,8 +48,8 @@ export default {
     },
     /**
      * @description 注销用户并返回登录页面
-     * @param {Object} param context
-     * @param {Object} param confirm {Boolean} 是否需要确认
+     * @param {Object} context
+     * @param {Object} payload confirm {Boolean} 是否需要确认
      */
     logout ({ commit, dispatch }, { confirm = false } = {}) {
       /**
@@ -90,7 +90,7 @@ export default {
     },
     /**
      * @description 用户登录后从持久化数据加载一系列的设置
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     load ({ dispatch }) {
       return new Promise(async resolve => {
diff --git a/src/store/modules/d2admin/modules/color.js b/src/store/modules/d2admin/modules/color.js
index 6dafc36f..0b22cbad 100644
--- a/src/store/modules/d2admin/modules/color.js
+++ b/src/store/modules/d2admin/modules/color.js
@@ -10,7 +10,7 @@ export default {
   actions: {
     /**
      * @description 设置颜色
-     * @param {Object} state vuex state
+     * @param {Object} context
      * @param {String} color 尺寸
      */
     set ({ state, dispatch, commit }, color) {
@@ -37,7 +37,7 @@ export default {
     },
     /**
      * @description 从持久化数据读取颜色设置
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     load ({ state, dispatch, commit }) {
       return new Promise(async resolve => {
@@ -63,8 +63,9 @@ export default {
   mutations: {
     /**
      * @description 将 vuex 中的主题颜色设置应用到系统中
-     * @param {Object} state vuex state
-     * @param {Object} payload 设置
+     * @param {Object} context
+     * @param {Object} payload oldColor {String} 旧的颜色
+     * @param {Object} payload newColor {String} 新颜色
      */
     apply (state, { oldColor, newColor }) {
       var options = {
diff --git a/src/store/modules/d2admin/modules/db.js b/src/store/modules/d2admin/modules/db.js
index 00cc136b..7232f5e8 100644
--- a/src/store/modules/d2admin/modules/db.js
+++ b/src/store/modules/d2admin/modules/db.js
@@ -8,11 +8,11 @@ export default {
     /**
      * @description 将数据存储到指定位置 | 路径不存在会自动初始化
      * @description 效果类似于取值 dbName.path = value
-     * @param {Object} context context
-     * @param {Object} param dbName {String} 数据库名称
-     * @param {Object} param path {String} 存储路径
-     * @param {Object} param value {*} 需要存储的值
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload dbName {String} 数据库名称
+     * @param {Object} payload path {String} 存储路径
+     * @param {Object} payload value {*} 需要存储的值
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     set (context, {
       dbName = 'database',
@@ -25,11 +25,11 @@ export default {
     /**
      * @description 获取数据
      * @description 效果类似于取值 dbName.path || defaultValue
-     * @param {Object} context context
-     * @param {Object} param dbName {String} 数据库名称
-     * @param {Object} param path {String} 存储路径
-     * @param {Object} param defaultValue {*} 取值失败的默认值
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload dbName {String} 数据库名称
+     * @param {Object} payload path {String} 存储路径
+     * @param {Object} payload defaultValue {*} 取值失败的默认值
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     get (context, {
       dbName = 'database',
@@ -41,8 +41,8 @@ export default {
     },
     /**
      * @description 获取存储数据库对象
-     * @param {Object} context context
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     database (context, {
       user = false
@@ -54,8 +54,8 @@ export default {
     },
     /**
      * @description 清空存储数据库对象
-     * @param {Object} context context
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     databaseClear (context, {
       user = false
@@ -68,9 +68,9 @@ export default {
     },
     /**
      * @description 获取存储数据库对象 [ 区分页面 ]
-     * @param {Object} context context
-     * @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ]
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     databasePage (context, {
       basis = 'fullPath',
@@ -84,9 +84,9 @@ export default {
     },
     /**
      * @description 清空存储数据库对象 [ 区分页面 ]
-     * @param {Object} context context
-     * @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ]
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     databasePageClear (context, {
       basis = 'fullPath',
@@ -101,10 +101,10 @@ export default {
     },
     /**
      * @description 快速将页面当前的数据 ( $data ) 持久化
-     * @param {Object} context context
-     * @param {Object} param instance {Object} vue 实例
-     * @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ]
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload instance {Object} vue 实例
+     * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     pageSet (context, {
       instance,
@@ -120,10 +120,10 @@ export default {
     },
     /**
      * @description 快速获取页面快速持久化的数据
-     * @param {Object} context context
-     * @param {Object} param instance {Object} vue 实例
-     * @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ]
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload instance {Object} vue 实例
+     * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     pageGet (context, {
       instance,
@@ -138,9 +138,9 @@ export default {
     },
     /**
      * @description 清空页面快照
-     * @param {Object} context context
-     * @param {Object} param basis {String} 页面区分依据 [ name | path | fullPath ]
-     * @param {Object} param user {Boolean} 是否区分用户
+     * @param {Object} context
+     * @param {Object} payload basis {String} 页面区分依据 [ name | path | fullPath ]
+     * @param {Object} payload user {Boolean} 是否区分用户
      */
     pageClear (context, {
       basis = 'fullPath',
diff --git a/src/store/modules/d2admin/modules/fullscreen.js b/src/store/modules/d2admin/modules/fullscreen.js
index 3a48da54..328237c0 100644
--- a/src/store/modules/d2admin/modules/fullscreen.js
+++ b/src/store/modules/d2admin/modules/fullscreen.js
@@ -9,6 +9,7 @@ export default {
   actions: {
     /**
      * @description 初始化监听
+     * @param {Object} context
      */
     listen ({ commit }) {
       return new Promise(resolve => {
@@ -26,6 +27,7 @@ export default {
     },
     /**
      * @description 切换全屏
+     * @param {Object} context
      */
     toggle ({ commit }) {
       return new Promise(resolve => {
@@ -44,7 +46,7 @@ export default {
   mutations: {
     /**
      * @description 设置 store 里的全屏状态
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Boolean} active active
      */
     set (state, active) {
diff --git a/src/store/modules/d2admin/modules/gray.js b/src/store/modules/d2admin/modules/gray.js
index b46c88c5..841ad3e7 100644
--- a/src/store/modules/d2admin/modules/gray.js
+++ b/src/store/modules/d2admin/modules/gray.js
@@ -7,14 +7,14 @@ export default {
   mutations: {
     /**
      * @description 切换灰度状态
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     toggle (state) {
       state.active = !state.active
     },
     /**
      * @description 设置灰度模式
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Boolean} active active
      */
     set (state, active) {
diff --git a/src/store/modules/d2admin/modules/log.js b/src/store/modules/d2admin/modules/log.js
index 862f7b40..267e0ffe 100644
--- a/src/store/modules/d2admin/modules/log.js
+++ b/src/store/modules/d2admin/modules/log.js
@@ -32,9 +32,10 @@ export default {
   actions: {
     /**
      * @description 添加一个日志
+     * @param {Object} context
      * @param {String} param message {String} 信息
      * @param {String} param type {String} 类型
-     * @param {Object} param meta {Object} 附带的信息
+     * @param {Object} payload meta {Object} 附带的信息
      */
     push ({ rootState, commit }, { message, type = 'info', meta }) {
       commit('push', {
@@ -59,7 +60,7 @@ export default {
   mutations: {
     /**
      * @description 添加日志
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Object} log data
      */
     push (state, log) {
@@ -67,7 +68,7 @@ export default {
     },
     /**
      * @description 清空日志
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     clean (state) {
       // store 赋值
diff --git a/src/store/modules/d2admin/modules/menu.js b/src/store/modules/d2admin/modules/menu.js
index a26cba70..6a1fd4c8 100644
--- a/src/store/modules/d2admin/modules/menu.js
+++ b/src/store/modules/d2admin/modules/menu.js
@@ -30,7 +30,7 @@ export default {
   actions: {
     /**
      * 设置侧边栏展开或者收缩
-     * @param {Object} state vuex state
+     * @param {Object} context
      * @param {Boolean} collapse is collapse
      */
     asideCollapseSet ({ state, dispatch }, collapse) {
@@ -50,7 +50,7 @@ export default {
     },
     /**
      * 切换侧边栏展开和收缩
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     asideCollapseToggle ({ state, dispatch }) {
       return new Promise(async resolve => {
@@ -69,7 +69,7 @@ export default {
     },
     /**
      * 从持久化数据读取侧边栏展开或者收缩
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     asideCollapseLoad ({ state, dispatch }) {
       return new Promise(async resolve => {
@@ -88,7 +88,7 @@ export default {
   mutations: {
     /**
      * @description 设置顶栏菜单
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Array} menu menu setting
      */
     headerSet (state, menu) {
@@ -97,7 +97,7 @@ export default {
     },
     /**
      * @description 设置侧边栏菜单
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Array} menu menu setting
      */
     asideSet (state, menu) {
diff --git a/src/store/modules/d2admin/modules/page.js.REMOVED.git-id b/src/store/modules/d2admin/modules/page.js.REMOVED.git-id
index 3520f687..a88449ac 100644
--- a/src/store/modules/d2admin/modules/page.js.REMOVED.git-id
+++ b/src/store/modules/d2admin/modules/page.js.REMOVED.git-id
@@ -1 +1 @@
-f6db6b641667fe94ef45b30706bc285c62e33d1b
\ No newline at end of file
+98fef2a08200b7f751bbfef385cd47f54bc8ce5c
\ No newline at end of file
diff --git a/src/store/modules/d2admin/modules/releases.js b/src/store/modules/d2admin/modules/releases.js
index 3693388b..2d2d5939 100644
--- a/src/store/modules/d2admin/modules/releases.js
+++ b/src/store/modules/d2admin/modules/releases.js
@@ -5,7 +5,7 @@ export default {
   mutations: {
     /**
      * @description 显示版本信息
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     versionShow () {
       util.log.capsule('D2Admin', `v${process.env.VUE_APP_VERSION}`)
diff --git a/src/store/modules/d2admin/modules/search.js b/src/store/modules/d2admin/modules/search.js
index 73d2390f..934f44b5 100644
--- a/src/store/modules/d2admin/modules/search.js
+++ b/src/store/modules/d2admin/modules/search.js
@@ -16,14 +16,14 @@ export default {
   mutations: {
     /**
      * @description 切换激活状态
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     toggle (state) {
       state.active = !state.active
     },
     /**
      * @description 设置激活模式
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Boolean} active active
      */
     set (state, active) {
@@ -31,7 +31,7 @@ export default {
     },
     /**
      * @description 初始化
-     * @param {Object} state vuex state
+     * @param {Object} state state
      * @param {Array} menu menu
      */
     init (state, menu) {
diff --git a/src/store/modules/d2admin/modules/size.js b/src/store/modules/d2admin/modules/size.js
index e5bdb4a6..539e6d41 100644
--- a/src/store/modules/d2admin/modules/size.js
+++ b/src/store/modules/d2admin/modules/size.js
@@ -10,6 +10,7 @@ export default {
   actions: {
     /**
      * @description 将当前的设置应用到 element
+     * @param {Object} context
      * @param {Boolean} refresh 是否在设置之后刷新页面
      */
     apply ({ state, commit }, refresh) {
@@ -21,6 +22,7 @@ export default {
     },
     /**
      * @description 确认已经加载组件尺寸设置 https://github.com/d2-projects/d2-admin/issues/198
+     * @param {Object} context
      */
     isLoaded ({ state }) {
       if (state.value) return Promise.resolve()
@@ -34,7 +36,7 @@ export default {
     },
     /**
      * @description 设置尺寸
-     * @param {Object} state vuex state
+     * @param {Object} context
      * @param {String} size 尺寸
      */
     set ({ state, dispatch }, size) {
@@ -56,7 +58,7 @@ export default {
     },
     /**
      * @description 从持久化数据读取尺寸设置
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     load ({ state, dispatch }) {
       return new Promise(async resolve => {
diff --git a/src/store/modules/d2admin/modules/theme.js b/src/store/modules/d2admin/modules/theme.js
index ae653514..93f1c23e 100644
--- a/src/store/modules/d2admin/modules/theme.js
+++ b/src/store/modules/d2admin/modules/theme.js
@@ -12,7 +12,7 @@ export default {
   getters: {
     /**
      * @description 返回当前的主题信息 不是一个名字 而是当前激活主题的所有数据
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     activeSetting (state) {
       return state.list.find(theme => theme.name === state.activeName)
@@ -21,7 +21,6 @@ export default {
   actions: {
     /**
      * @description 激活一个主题
-     * @param {Object} state vuex state
      * @param {String} themeValue 需要激活的主题名称
      */
     set ({ state, commit, dispatch }, themeName) {
@@ -42,8 +41,7 @@ export default {
       })
     },
     /**
-     * @description 从持久化数据加载主题设置
-     * @param {Object} state vuex state
+     * @description 从持久化数据加载主题设置     * @param {Object} context
      */
     load ({ state, commit, dispatch }) {
       return new Promise(async resolve => {
@@ -77,7 +75,7 @@ export default {
   mutations: {
     /**
      * @description 将 vuex 中的主题应用到 dom
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     dom (state) {
       document.body.className = `theme-${state.activeName}`
diff --git a/src/store/modules/d2admin/modules/transition.js b/src/store/modules/d2admin/modules/transition.js
index f4802bff..38494648 100644
--- a/src/store/modules/d2admin/modules/transition.js
+++ b/src/store/modules/d2admin/modules/transition.js
@@ -10,7 +10,7 @@ export default {
   actions: {
     /**
      * @description 设置开启状态
-     * @param {Object} state vuex state
+     * @param {Object} context
      * @param {Boolean} active 新的状态
      */
     set ({ state, dispatch }, active) {
@@ -30,7 +30,7 @@ export default {
     },
     /**
      * 从数据库读取页面过渡动画设置
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     load ({ state, dispatch }) {
       return new Promise(async resolve => {
diff --git a/src/store/modules/d2admin/modules/ua.js b/src/store/modules/d2admin/modules/ua.js
index 05c50d7a..f5f7b3c4 100644
--- a/src/store/modules/d2admin/modules/ua.js
+++ b/src/store/modules/d2admin/modules/ua.js
@@ -9,7 +9,7 @@ export default {
   mutations: {
     /**
      * @description 记录 UA
-     * @param {Object} state vuex state
+     * @param {Object} state state
      */
     get (state) {
       state.data = new UaParser().getResult()
diff --git a/src/store/modules/d2admin/modules/user.js b/src/store/modules/d2admin/modules/user.js
index 37d3baca..1a552462 100644
--- a/src/store/modules/d2admin/modules/user.js
+++ b/src/store/modules/d2admin/modules/user.js
@@ -7,7 +7,7 @@ export default {
   actions: {
     /**
      * @description 设置用户数据
-     * @param {Object} state vuex state
+     * @param {Object} context
      * @param {*} info info
      */
     set ({ state, dispatch }, info) {
@@ -27,7 +27,7 @@ export default {
     },
     /**
      * @description 从数据库取用户数据
-     * @param {Object} state vuex state
+     * @param {Object} context
      */
     load ({ state, dispatch }) {
       return new Promise(async resolve => {