From 533478c73089b4cf1acddffc0a30835aa9369b3c Mon Sep 17 00:00:00 2001
From: "yadong.zhang" <yadong.zhang0415@gmail.com>
Date: Mon, 19 Apr 2021 14:38:21 +0800
Subject: [PATCH] :beers: Add comments

---
 .../com/fujieid/jap/ids/service/IdsUserService.java   | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/jap-ids/src/main/java/com/fujieid/jap/ids/service/IdsUserService.java b/jap-ids/src/main/java/com/fujieid/jap/ids/service/IdsUserService.java
index 4388708..a54d141 100644
--- a/jap-ids/src/main/java/com/fujieid/jap/ids/service/IdsUserService.java
+++ b/jap-ids/src/main/java/com/fujieid/jap/ids/service/IdsUserService.java
@@ -27,6 +27,13 @@ import com.fujieid.jap.ids.model.UserInfo;
  */
 public interface IdsUserService {
 
+    /**
+     * Login with account and password
+     *
+     * @param username account number
+     * @param password password
+     * @return UserInfo
+     */
     default UserInfo loginByUsernameAndPassword(String username, String password) {
         throw new IdsException("Not implemented `IdsUserService.loginByUsernameAndPassword(String, String)`");
     }
@@ -35,7 +42,7 @@ public interface IdsUserService {
      * Get user info by userid.
      *
      * @param userId userId of the business system
-     * @return JapUser
+     * @return UserInfo
      */
     default UserInfo getById(String userId) {
         throw new IdsException("Not implemented `IdsUserService.getById(String)`");
@@ -45,7 +52,7 @@ public interface IdsUserService {
      * Get user info by username.
      *
      * @param username username of the business system
-     * @return JapUser
+     * @return UserInfo
      */
     default UserInfo getByName(String username) {
         throw new IdsException("Not implemented `IdsUserService.getByName(String)`");