From 972f8c3afff646bf15d66c58c43331e088a9ccd8 Mon Sep 17 00:00:00 2001
From: John Guo <john@johng.cn>
Date: Tue, 17 Oct 2023 21:09:46 +0800
Subject: [PATCH] improve comments for package gconv (#3057)

---
 util/gconv/gconv_scan.go | 43 ++++++++++++++++++++++------------------
 1 file changed, 24 insertions(+), 19 deletions(-)

diff --git a/util/gconv/gconv_scan.go b/util/gconv/gconv_scan.go
index 28f7d7b4f89..b31c4a3b893 100644
--- a/util/gconv/gconv_scan.go
+++ b/util/gconv/gconv_scan.go
@@ -114,34 +114,37 @@ func Scan(params interface{}, pointer interface{}, mapping ...map[string]string)
 // Usage example 1: Normal attribute struct relation:
 //
 //	type EntityUser struct {
-//		   Uid  int
-//		   Name string
+//	    Uid  int
+//	    Name string
 //	}
 //
 //	type EntityUserDetail struct {
-//		   Uid     int
-//		   Address string
+//	    Uid     int
+//	    Address string
 //	}
 //
 //	type EntityUserScores struct {
-//		   Id     int
-//		   Uid    int
-//		   Score  int
-//		   Course string
+//	    Id     int
+//	    Uid    int
+//	    Score  int
+//	    Course string
 //	}
 //
 //	type Entity struct {
 //	    User       *EntityUser
-//		   UserDetail *EntityUserDetail
-//		   UserScores []*EntityUserScores
+//	    UserDetail *EntityUserDetail
+//	    UserScores []*EntityUserScores
 //	}
 //
 // var users []*Entity
-// ScanList(records, &users, "User")
-// ScanList(records, &users, "User", "uid")
-// ScanList(records, &users, "UserDetail", "User", "uid:Uid")
-// ScanList(records, &users, "UserScores", "User", "uid:Uid")
-// ScanList(records, &users, "UserScores", "User", "uid")
+// var userRecords   = EntityUser{Uid: 1, Name:"john"}
+// var detailRecords = EntityUser{Uid: 1, Address: "chengdu"}
+// var scoresRecords = EntityUser{Id: 1, Uid: 1, Score: 100, Course: "math"}
+// ScanList(userRecords, &users, "User")
+// ScanList(userRecords, &users, "User", "uid")
+// ScanList(detailRecords, &users, "UserDetail", "User", "uid:Uid")
+// ScanList(scoresRecords, &users, "UserScores", "User", "uid:Uid")
+// ScanList(scoresRecords, &users, "UserScores", "User", "uid")
 //
 // Usage example 2: Embedded attribute struct relation:
 //
@@ -167,10 +170,12 @@ func Scan(params interface{}, pointer interface{}, mapping ...map[string]string)
 //		   UserScores []EntityUserScores
 //	}
 //
-// var users []*Entity
-// ScanList(records, &users)
-// ScanList(records, &users, "UserDetail", "uid")
-// ScanList(records, &users, "UserScores", "uid")
+// var userRecords   = EntityUser{Uid: 1, Name:"john"}
+// var detailRecords = EntityUser{Uid: 1, Address: "chengdu"}
+// var scoresRecords = EntityUser{Id: 1, Uid: 1, Score: 100, Course: "math"}
+// ScanList(userRecords, &users)
+// ScanList(detailRecords, &users, "UserDetail", "uid")
+// ScanList(scoresRecords, &users, "UserScores", "uid")
 //
 // The parameters "User/UserDetail/UserScores" in the example codes specify the target attribute struct
 // that current result will be bound to.