From b202e148e3a16c7adce0c7615f6656776d8ec8ce Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=8E=8B=E4=BA=9A=E7=90=AA?= <wangyaqi988@163.com>
Date: Thu, 23 Jun 2022 21:34:20 +0800
Subject: [PATCH] docs: update jsdoc

---
 .../cloudfunctions/uni-id-co/index.obj.js     | 258 +++++++++++++++++-
 .../uni-id-co/module/account/close-account.js |   1 +
 .../module/account/get-account-info.js        |   1 +
 .../module/account/reset-pwd-by-sms.js        |   1 +
 .../uni-id-co/module/account/update-pwd.js    | 105 +++----
 .../uni-id-co/module/admin/add-user.js        |   1 +
 .../module/dev/get-supported-login-type.js    |   1 +
 .../uni-id-co/module/fission/accept-invite.js |   1 +
 .../module/fission/get-invited-user.js        |   1 +
 .../uni-id-co/module/login/login-by-alipay.js |   1 +
 .../uni-id-co/module/login/login-by-apple.js  |   1 +
 .../uni-id-co/module/login/login-by-qq.js     |   1 +
 .../uni-id-co/module/login/login-by-sms.js    |   1 +
 .../module/login/login-by-univerify.js        |   1 +
 .../uni-id-co/module/login/login-by-weixin.js |   1 +
 .../uni-id-co/module/login/login.js           |   1 +
 .../uni-id-co/module/logout/logout.js         |   1 +
 .../module/multi-end/authorize-app-login.js   |   1 +
 .../module/multi-end/remove-authorized-app.js |   1 +
 .../module/multi-end/set-authorized-app.js    |   1 +
 .../module/register/register-admin.js         |   1 +
 .../module/register/register-user.js          |   1 +
 .../uni-id-co/module/relate/bind-alipay.js    |   1 +
 .../uni-id-co/module/relate/bind-apple.js     |   1 +
 .../module/relate/bind-mobile-by-mp-weixin.js |   1 +
 .../module/relate/bind-mobile-by-sms.js       |   1 +
 .../module/relate/bind-mobile-by-univerify.js |   1 +
 .../uni-id-co/module/relate/bind-qq.js        |   1 +
 .../uni-id-co/module/relate/bind-weixin.js    |   1 +
 .../uni-id-co/module/utils/refresh-token.js   |   1 +
 .../uni-id-co/module/utils/set-push-cid.js    |   1 +
 .../uni-id-co/module/verify/create-captcha.js |   1 +
 .../module/verify/refresh-captcha.js          |   1 +
 .../module/verify/send-email-code.js          |   1 +
 .../module/verify/send-email-link.js          |   1 +
 .../uni-id-co/module/verify/send-sms-code.js  |   1 +
 36 files changed, 344 insertions(+), 53 deletions(-)

diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/index.obj.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/index.obj.js
index a9653d1..c32f675 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/index.obj.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/index.obj.js
@@ -139,7 +139,7 @@ module.exports = {
   },
   /**
    * 注册管理员
-   * @tutorial https://dcloud.io
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#register-admin
    * @param {Object} params
    * @param {String} params.username   用户名
    * @param {String} params.password   密码
@@ -147,36 +147,292 @@ module.exports = {
    * @returns
    */
   registerAdmin,
+  /**
+   * 新增用户
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#add-user
+   * @param {Object}  params
+   * @param {String}  params.username       用户名
+   * @param {String}  params.password       密码
+   * @param {String}  params.nickname       昵称
+   * @param {Array}   params.authorizedApp  允许登录的AppID列表
+   * @param {Array}   params.role           用户角色列表
+   * @returns
+   */
   addUser,
+  /**
+   * 授权用户登录应用
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#authorize-app-login
+   * @param {Object} params
+   * @param {String} params.uid   用户id
+   * @param {String} params.appId 授权的应用的AppId
+   * @returns
+   */
   authorizeAppLogin,
+  /**
+   * 移除用户登录授权
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#remove-authorized-app
+   * @param {Object} params
+   * @param {String} params.uid   用户id
+   * @param {String} params.appId 取消授权的应用的AppId
+   * @returns
+   */
   removeAuthorizedApp,
+  /**
+   * 设置用户允许登录的应用列表
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#set-authorized-app
+   * @param {Object} params
+   * @param {String} params.uid       用户id
+   * @param {Array} params.appIdList 允许登录的应用AppId列表
+   * @returns
+   */
   setAuthorizedApp,
+  /**
+   * 注册普通用户
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#register-user
+   * @param {Object} params
+   * @param {String} params.username    用户名
+   * @param {String} params.password    密码
+   * @param {String} params.captcha     图形验证码
+   * @param {String} params.nickname    昵称
+   * @param {String} params.inviteCode  邀请码
+   * @returns
+   */
   registerUser,
+  /**
+   * 用户名密码登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login
+   * @param {Object} params
+   * @param {String} params.username  用户名
+   * @param {String} params.mobile    手机号
+   * @param {String} params.email     邮箱
+   * @param {String} params.password  密码
+   * @param {String} params.captcha   图形验证码
+   * @returns
+   */
   login,
+  /**
+   * 短信验证码登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-sms
+   * @param {Object} params
+   * @param {String} params.mobile      手机号
+   * @param {String} params.code        短信验证码
+   * @param {String} params.captcha     图形验证码
+   * @param {String} params.inviteCode  邀请码
+   * @returns
+   */
   loginBySms,
+  /**
+   * App端一键登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-univerify
+   * @param {Object} params
+   * @param {String} params.access_token  APP端一键登录返回的access_token
+   * @param {String} params.openid        APP端一键登录返回的openid
+   * @param {String} params.inviteCode    邀请码
+   * @returns
+   */
   loginByUniverify,
+  /**
+   * 微信登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-weixin
+   * @param {Object} params
+   * @param {String} params.code          微信登录返回的code
+   * @param {String} params.inviteCode    邀请码
+   * @returns
+   */
   loginByWeixin,
+  /**
+   * 支付宝登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-alipay
+   * @param {Object} params
+   * @param {String} params.code        支付宝小程序客户端登录返回的code
+   * @param {String} params.inviteCode  邀请码
+   * @returns
+   */
   loginByAlipay,
+  /**
+   * QQ登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-qq
+   * @param {Object} params
+   * @param {String} params.code                  QQ小程序登录返回的code参数
+   * @param {String} params.accessToken           App端QQ登录返回的accessToken参数
+   * @param {String} params.accessTokenExpired    由App端QQ登录返回的expires_in参数计算而来
+   * @param {String} params.inviteCode            邀请码
+   * @returns
+   */
   loginByQQ,
+  /**
+   * 苹果登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-apple
+   * @param {Object} params
+   * @param {String} params.identityToken 苹果登录返回的identityToken
+   * @param {String} params.nickname      用户昵称
+   * @param {String} params.inviteCode    邀请码
+   * @returns
+   */
   loginByApple,
+  /**
+   * 用户退出登录
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#logout
+   * @returns
+   */
   logout,
+  /**
+   * 通过短信验证码绑定手机号
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-sms
+   * @param {Object} params
+   * @param {String} params.mobile    手机号
+   * @param {String} params.code      短信验证码
+   * @param {String} params.captcha   图形验证码
+   * @returns
+   */
   bindMobileBySms,
+  /**
+   * 通过一键登录绑定手机号
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-univerify
+   * @param {Object} params
+   * @param {String} params.openid        APP端一键登录返回的openid
+   * @param {String} params.access_token  APP端一键登录返回的access_token
+   * @returns
+   */
   bindMobileByUniverify,
+  /**
+   * 通过微信绑定手机号
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-mp-weixin
+   * @param {Object} params
+   * @param {String} params.encryptedData   微信获取手机号返回的加密信息
+   * @param {String} params.iv              微信获取手机号返回的初始向量
+   * @returns
+   */
   bindMobileByMpWeixin,
+  /**
+   * 绑定微信
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-weixin
+   * @param {Object} params
+   * @param {String} params.code  微信登录返回的code
+   * @returns
+   */
   bindWeixin,
+  /**
+   * 绑定QQ
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-qq
+   * @param {Object} params
+   * @param {String} params.code          小程序端QQ登录返回的code
+   * @param {String} params.accessToken   APP端QQ登录返回的accessToken
+   * @returns
+   */
   bindQQ,
+  /**
+   * 绑定支付宝账号
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-alipay
+   * @param {Object} params
+   * @param {String} params.code  支付宝小程序登录返回的code参数
+   * @returns
+   */
   bindAlipay,
+  /**
+   * 绑定苹果账号
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-apple
+   * @param {Object} params
+   * @param {String} params.identityToken 苹果登录返回identityToken
+   * @returns
+   */
   bindApple,
+  /**
+   * 更新密码
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#update-pwd
+   * @param {object} params
+   * @param {string} params.oldPassword 旧密码
+   * @param {string} params.newPassword 新密码
+   * @returns {object}
+   */
   updatePwd,
+  /**
+   * 通过短信验证码重置密码
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#reset-pwd-by-sms
+   * @param {object} params
+   * @param {string} params.mobile   手机号
+   * @param {string} params.mobile   短信验证码
+   * @param {string} params.password 密码
+   * @param {string} params.captcha  图形验证码
+   * @returns {object}
+   */
   resetPwdBySms,
+  /**
+   * 注销账户
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#close-account
+   * @returns
+   */
   closeAccount,
+  /**
+   * 获取账户账户简略信息
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-account-info
+   */
   getAccountInfo,
+  /**
+   * 创建图形验证码
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#create-captcha
+   * @param {Object} params
+   * @param {String} params.scene   图形验证码使用场景
+   * @returns
+   */
   createCaptcha,
+  /**
+   * 刷新图形验证码
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#refresh-captcha
+   * @param {Object} params
+   * @param {String} params.scene   图形验证码使用场景
+   * @returns
+   */
   refreshCaptcha,
+  /**
+   * 发送短信验证码
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#send-sms-code
+   * @param {Object} params
+   * @param {String} params.mobile    手机号
+   * @param {String} params.captcha   图形验证码
+   * @param {String} params.scene     短信验证码使用场景
+   * @returns
+   */
   sendSmsCode,
+  /**
+   * 刷新token
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#refresh-token
+   */
   refreshToken,
+  /**
+   * 接受邀请
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#accept-invite
+   * @param {Object} params
+   * @param {String} params.inviteCode  邀请码
+   * @returns
+   */
   acceptInvite,
+  /**
+   * 获取受邀用户
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-invited-user
+   * @param {Object} params
+   * @param {Number} params.level       获取受邀用户的级数，1表示直接邀请的用户
+   * @param {Number} params.limit       返回数据大小
+   * @param {Number} params.offset      返回数据偏移
+   * @param {Boolean} params.needTotal  是否需要返回总数
+   * @returns
+   */
   getInvitedUser,
+  /**
+   * 更新device表的push_clien_id
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#set-push-cid
+   * @param {object} params
+   * @param {string} params.pushClientId  客户端pushClientId
+   * @returns
+   */
   setPushCid,
+  /**
+   * 获取支持的登录方式
+   * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-supported-login-type
+   * @param {Object} params
+   * @param {String} params.appId     应用AppId
+   * @param {String} params.platform  应用平台
+   * @returns
+   */
   getSupportedLoginType
 }
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/close-account.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/close-account.js
index e0897c5..f1bdf96 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/close-account.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/close-account.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 注销账户
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#close-account
  * @returns
  */
 module.exports = async function () {
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/get-account-info.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/get-account-info.js
index a0f4919..9c7fcec 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/get-account-info.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/get-account-info.js
@@ -41,6 +41,7 @@ function isAppleBound (userRecord) {
 
 /**
  * 获取账户账户简略信息
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-account-info
  */
 module.exports = async function () {
   const {
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/reset-pwd-by-sms.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/reset-pwd-by-sms.js
index d0988e8..646834f 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/reset-pwd-by-sms.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/reset-pwd-by-sms.js
@@ -21,6 +21,7 @@ const PasswordUtils = require('../../lib/utils/password')
 
 /**
  * 通过短信验证码重置密码
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#reset-pwd-by-sms
  * @param {object} params
  * @param {string} params.mobile   手机号
  * @param {string} params.mobile   短信验证码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/update-pwd.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/update-pwd.js
index a6e0ef1..7329b73 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/update-pwd.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/account/update-pwd.js
@@ -1,66 +1,67 @@
 const {
-	userCollection
+  userCollection
 } = require('../../common/constants')
 const {
-	ERROR
+  ERROR
 } = require('../../common/error')
 const PasswordUtils = require('../../lib/utils/password')
 /**
  * 更新密码
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#update-pwd
  * @param {object} params
  * @param {string} params.oldPassword 旧密码
  * @param {string} params.newPassword 新密码
  * @returns {object}
  */
-module.exports = async function(params = {}) {
-	const schema = {
-		oldPassword: 'string', // 防止密码规则调整导致旧密码无法更新
-		newPassword: 'password'
-	}
-	this.middleware.validate(params, schema)
-	const uid = this.authInfo.uid
-	const getUserRes = await userCollection.doc(uid).get()
-	const userRecord = getUserRes.data[0]
-	if (!userRecord) {
-		throw {
-			errCode: ERROR.ACCOUNT_NOT_EXISTS
-		}
-	}
-	const {
-		oldPassword,
-		newPassword
-	} = params
-	const passwordUtils = new PasswordUtils({
-		passwordSecret: this.config.passwordSecret
-	})
-	const {
-		success: checkPasswordSuccess
-	} = passwordUtils.checkUserPassword({
-		password: oldPassword,
-		passwordHash: userRecord.password,
-		passwordSecretVersion: userRecord.password_secret_version,
-		autoRefresh: false
-	})
-	if (!checkPasswordSuccess) {
-		throw {
-			errCode: ERROR.PASSWORD_ERROR
-		}
-	}
+module.exports = async function (params = {}) {
+  const schema = {
+    oldPassword: 'string', // 防止密码规则调整导致旧密码无法更新
+    newPassword: 'password'
+  }
+  this.middleware.validate(params, schema)
+  const uid = this.authInfo.uid
+  const getUserRes = await userCollection.doc(uid).get()
+  const userRecord = getUserRes.data[0]
+  if (!userRecord) {
+    throw {
+      errCode: ERROR.ACCOUNT_NOT_EXISTS
+    }
+  }
+  const {
+    oldPassword,
+    newPassword
+  } = params
+  const passwordUtils = new PasswordUtils({
+    passwordSecret: this.config.passwordSecret
+  })
+  const {
+    success: checkPasswordSuccess
+  } = passwordUtils.checkUserPassword({
+    password: oldPassword,
+    passwordHash: userRecord.password,
+    passwordSecretVersion: userRecord.password_secret_version,
+    autoRefresh: false
+  })
+  if (!checkPasswordSuccess) {
+    throw {
+      errCode: ERROR.PASSWORD_ERROR
+    }
+  }
 
-	const {
-		passwordHash,
-		version
-	} = passwordUtils.generatePasswordHash({
-		password: newPassword
-	})
+  const {
+    passwordHash,
+    version
+  } = passwordUtils.generatePasswordHash({
+    password: newPassword
+  })
 
-	await userCollection.doc(uid).update({
-		password: passwordHash,
-		password_secret_version: version,
-		valid_token_date: Date.now() // refreshToken时会校验，如果创建token时间在此时间点之前，则拒绝下发新token，返回token失效错误码
-	})
-	// 执行更新密码操作后客户端应将用户退出重新登录
-	return {
-		errCode: 0
-	}
-}
+  await userCollection.doc(uid).update({
+    password: passwordHash,
+    password_secret_version: version,
+    valid_token_date: Date.now() // refreshToken时会校验，如果创建token时间在此时间点之前，则拒绝下发新token，返回token失效错误码
+  })
+  // 执行更新密码操作后客户端应将用户退出重新登录
+  return {
+    errCode: 0
+  }
+}
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/admin/add-user.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/admin/add-user.js
index 77dbdb1..988ee5b 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/admin/add-user.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/admin/add-user.js
@@ -11,6 +11,7 @@ const PasswordUtils = require('../../lib/utils/password')
 
 /**
  * 新增用户
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#add-user
  * @param {Object}  params
  * @param {String}  params.username       用户名
  * @param {String}  params.password       密码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/dev/get-supported-login-type.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/dev/get-supported-login-type.js
index e55339a..f323134 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/dev/get-supported-login-type.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/dev/get-supported-login-type.js
@@ -35,6 +35,7 @@ const ConfigUtils = require('../../lib/utils/config')
 
 /**
  * 获取支持的登录方式
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-supported-login-type
  * @param {Object} params
  * @param {String} params.appId     应用AppId
  * @param {String} params.platform  应用平台
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/accept-invite.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/accept-invite.js
index b68a888..2461e06 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/accept-invite.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/accept-invite.js
@@ -4,6 +4,7 @@ const {
 
 /**
  * 接受邀请
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#accept-invite
  * @param {Object} params
  * @param {String} params.inviteCode  邀请码
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/get-invited-user.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/get-invited-user.js
index b371279..93d4671 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/get-invited-user.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/fission/get-invited-user.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 获取受邀用户
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#get-invited-user
  * @param {Object} params
  * @param {Number} params.level       获取受邀用户的级数，1表示直接邀请的用户
  * @param {Number} params.limit       返回数据大小
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-alipay.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-alipay.js
index 0f0a6c0..ef089aa 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-alipay.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-alipay.js
@@ -14,6 +14,7 @@ const {
 
 /**
  * 支付宝登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-alipay
  * @param {Object} params
  * @param {String} params.code        支付宝小程序客户端登录返回的code
  * @param {String} params.inviteCode  邀请码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-apple.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-apple.js
index 5d47819..265fde9 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-apple.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-apple.js
@@ -14,6 +14,7 @@ const {
 
 /**
  * 苹果登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-apple
  * @param {Object} params
  * @param {String} params.identityToken 苹果登录返回的identityToken
  * @param {String} params.nickname      用户昵称
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-qq.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-qq.js
index 35c7af7..2cd35b7 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-qq.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-qq.js
@@ -19,6 +19,7 @@ const url = require('url')
 
 /**
  * QQ登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-qq
  * @param {Object} params
  * @param {String} params.code                  QQ小程序登录返回的code参数
  * @param {String} params.accessToken           App端QQ登录返回的accessToken参数
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-sms.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-sms.js
index 030f5f8..8f9aeaf 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-sms.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-sms.js
@@ -17,6 +17,7 @@ const {
 
 /**
  * 短信验证码登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-sms
  * @param {Object} params
  * @param {String} params.mobile      手机号
  * @param {String} params.code        短信验证码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-univerify.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-univerify.js
index 13b5f5d..53e681c 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-univerify.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-univerify.js
@@ -11,6 +11,7 @@ const {
 
 /**
  * App端一键登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-univerify
  * @param {Object} params
  * @param {String} params.access_token  APP端一键登录返回的access_token
  * @param {String} params.openid        APP端一键登录返回的openid
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-weixin.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-weixin.js
index af3e0d3..6b83d47 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-weixin.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login-by-weixin.js
@@ -19,6 +19,7 @@ const url = require('url')
 
 /**
  * 微信登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login-by-weixin
  * @param {Object} params
  * @param {String} params.code          微信登录返回的code
  * @param {String} params.inviteCode    邀请码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login.js
index ae131b6..97e9cfe 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/login/login.js
@@ -15,6 +15,7 @@ const {
 
 /**
  * 用户名密码登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#login
  * @param {Object} params
  * @param {String} params.username  用户名
  * @param {String} params.mobile    手机号
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/logout/logout.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/logout/logout.js
index 9a6d0d5..4c0a7bf 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/logout/logout.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/logout/logout.js
@@ -4,6 +4,7 @@ const {
 } = require('../../common/constants')
 /**
  * 用户退出登录
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#logout
  * @returns
  */
 module.exports = async function () {
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/authorize-app-login.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/authorize-app-login.js
index 02b0d3a..8f8a167 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/authorize-app-login.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/authorize-app-login.js
@@ -8,6 +8,7 @@ const {
 
 /**
  * 授权用户登录应用
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#authorize-app-login
  * @param {Object} params
  * @param {String} params.uid   用户id
  * @param {String} params.appId 授权的应用的AppId
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/remove-authorized-app.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/remove-authorized-app.js
index 957f97e..6334e53 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/remove-authorized-app.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/remove-authorized-app.js
@@ -5,6 +5,7 @@ const {
 
 /**
  * 移除用户登录授权
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#remove-authorized-app
  * @param {Object} params
  * @param {String} params.uid   用户id
  * @param {String} params.appId 取消授权的应用的AppId
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/set-authorized-app.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/set-authorized-app.js
index 5ba9693..a438ef9 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/set-authorized-app.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/multi-end/set-authorized-app.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 设置用户允许登录的应用列表
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#set-authorized-app
  * @param {Object} params
  * @param {String} params.uid       用户id
  * @param {Array} params.appIdList 允许登录的应用AppId列表
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-admin.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-admin.js
index 7050421..a5535f6 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-admin.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-admin.js
@@ -11,6 +11,7 @@ const {
 
 /**
  * 注册管理员
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#register-admin
  * @param {Object} params
  * @param {String} params.username   用户名
  * @param {String} params.password   密码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-user.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-user.js
index 0c0d0c0..22db00e 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-user.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/register/register-user.js
@@ -8,6 +8,7 @@ const {
 
 /**
  * 注册普通用户
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#register-user
  * @param {Object} params
  * @param {String} params.username    用户名
  * @param {String} params.password    密码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-alipay.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-alipay.js
index 618584a..7c0c399 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-alipay.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-alipay.js
@@ -14,6 +14,7 @@ const {
 
 /**
  * 绑定支付宝账号
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-alipay
  * @param {Object} params
  * @param {String} params.code  支付宝小程序登录返回的code参数
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-apple.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-apple.js
index 2e54097..eb87f8b 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-apple.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-apple.js
@@ -14,6 +14,7 @@ const {
 
 /**
  * 绑定苹果账号
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-apple
  * @param {Object} params
  * @param {String} params.identityToken 苹果登录返回identityToken
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-mp-weixin.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-mp-weixin.js
index 93887f4..5da7259 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-mp-weixin.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-mp-weixin.js
@@ -12,6 +12,7 @@ const {
 
 /**
  * 通过微信绑定手机号
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-mp-weixin
  * @param {Object} params
  * @param {String} params.encryptedData   微信获取手机号返回的加密信息
  * @param {String} params.iv              微信获取手机号返回的初始向量
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-sms.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-sms.js
index 9fd3d6b..2275b05 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-sms.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-sms.js
@@ -17,6 +17,7 @@ const {
 
 /**
  * 通过短信验证码绑定手机号
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-sms
  * @param {Object} params
  * @param {String} params.mobile    手机号
  * @param {String} params.code      短信验证码
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-univerify.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-univerify.js
index cadb295..2970c61 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-univerify.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-mobile-by-univerify.js
@@ -11,6 +11,7 @@ const {
 
 /**
  * 通过一键登录绑定手机号
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-mobile-by-univerify
  * @param {Object} params
  * @param {String} params.openid        APP端一键登录返回的openid
  * @param {String} params.access_token  APP端一键登录返回的access_token
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-qq.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-qq.js
index 3f1e957..d0367f4 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-qq.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-qq.js
@@ -14,6 +14,7 @@ const {
 
 /**
  * 绑定QQ
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-qq
  * @param {Object} params
  * @param {String} params.code          小程序端QQ登录返回的code
  * @param {String} params.accessToken   APP端QQ登录返回的accessToken
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-weixin.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-weixin.js
index 0ff3f32..cec7c32 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-weixin.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/relate/bind-weixin.js
@@ -17,6 +17,7 @@ const {
 
 /**
  * 绑定微信
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#bind-weixin
  * @param {Object} params
  * @param {String} params.code  微信登录返回的code
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/refresh-token.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/refresh-token.js
index 5403aad..0c1837e 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/refresh-token.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/refresh-token.js
@@ -1,5 +1,6 @@
 /**
  * 刷新token
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#refresh-token
  */
 module.exports = async function () {
   const {
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/set-push-cid.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/set-push-cid.js
index 5cb80d4..2dcc420 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/set-push-cid.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/utils/set-push-cid.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 更新device表的push_clien_id
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#set-push-cid
  * @param {object} params
  * @param {string} params.pushClientId  客户端pushClientId
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/create-captcha.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/create-captcha.js
index 05526c7..1d77f5e 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/create-captcha.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/create-captcha.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 创建图形验证码
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#create-captcha
  * @param {Object} params
  * @param {String} params.scene   图形验证码使用场景
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/refresh-captcha.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/refresh-captcha.js
index f64170f..e5df246 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/refresh-captcha.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/refresh-captcha.js
@@ -7,6 +7,7 @@ const {
 
 /**
  * 刷新图形验证码
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#refresh-captcha
  * @param {Object} params
  * @param {String} params.scene   图形验证码使用场景
  * @returns
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-code.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-code.js
index c980cdf..6f2a5fd 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-code.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-code.js
@@ -1,5 +1,6 @@
 /**
  * 发送邮箱验证码，可用于登录、注册、绑定邮箱、修改密码等操作
+ * @tutorial
  * @param {Object} params
  * @param {String} params.email     邮箱
  * @param {String} params.scene     使用场景
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-link.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-link.js
index bc5b059..f643434 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-link.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-email-link.js
@@ -1,5 +1,6 @@
 /**
  * 发送邮箱链接，可用于登录、注册、绑定邮箱、修改密码等操作
+ * @tutorial
  * @param {Object} params
  * @param {String} params.email     邮箱
  * @param {String} params.scene     使用场景
diff --git a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-sms-code.js b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-sms-code.js
index bc8b110..a29c101 100644
--- a/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-sms-code.js
+++ b/uni_modules/uni-id-pages/uniCloud/cloudfunctions/uni-id-co/module/verify/send-sms-code.js
@@ -13,6 +13,7 @@ const {
 
 /**
  * 发送短信验证码
+ * @tutorial https://uniapp.dcloud.net.cn/uniCloud/uni-id-pages.html#send-sms-code
  * @param {Object} params
  * @param {String} params.mobile    手机号
  * @param {String} params.captcha   图形验证码
-- 
GitLab