doc: update doc for cryptor package

cryptor/basic.go

@@ -40,7 +40,7 @@ func Md5String(s string) string {
 	return hex.EncodeToString(h.Sum(nil))
 }
 
-// Md5String return the md5 value of string.
+// Md5StringWithBase64 return the md5 value of string with base64.
 // Play: https://go.dev/play/p/Lx4gH7Vdr5_y
 func Md5StringWithBase64(s string) string {
 	h := md5.New()
@@ -56,7 +56,7 @@ func Md5Byte(data []byte) string {
 	return hex.EncodeToString(h.Sum(nil))
 }
 
-// Md5Byte return the md5 string of byte slice.
+// Md5ByteWithBase64 return the md5 string of byte slice with base64.
 // Play: https://go.dev/play/p/CkN9hYKGeAy
 func Md5ByteWithBase64(data []byte) string {
 	h := md5.New()
@@ -98,104 +98,104 @@ func Md5File(filename string) (string, error) {
 
 // HmacMd5 return the hmac hash of string use md5.
 // Play: https://go.dev/play/p/uef0q1fz53I
-func HmacMd5(data, key string) string {
+func HmacMd5(str, key string) string {
 	h := hmac.New(md5.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return hex.EncodeToString(h.Sum([]byte("")))
 }
 
 // HmacSha1 return the hmac hash of string use sha1.
 // Play: https://go.dev/play/p/1UI4oQ4WXKM
-func HmacSha1(data, key string) string {
+func HmacSha1(str, key string) string {
 	h := hmac.New(sha1.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return hex.EncodeToString(h.Sum([]byte("")))
 }
 
-// HmacSha1 return the hmac hash of string use sha1.
+// HmacSha1WithBase64 return the hmac hash of string use sha1 with base64.
 // Play: https://go.dev/play/p/47JmmGrnF7B
-func HmacSha1WithBase64(data, key string) string {
+func HmacSha1WithBase64(str, key string) string {
 	h := hmac.New(sha1.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(h.Sum([]byte("")))
 }
 
 // HmacSha256 return the hmac hash of string use sha256.
 // Play: https://go.dev/play/p/HhpwXxFhhC0
-func HmacSha256(data, key string) string {
+func HmacSha256(str, key string) string {
 	h := hmac.New(sha256.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return hex.EncodeToString(h.Sum([]byte("")))
 }
 
-// HmacSha256 return the hmac hash of string use sha256 with base64.
+// HmacSha256WithBase64 return the hmac hash of string use sha256 with base64.
 // Play: https://go.dev/play/p/EKbkUvPTLwO
-func HmacSha256WithBase64(data, key string) string {
+func HmacSha256WithBase64(str, key string) string {
 	h := hmac.New(sha256.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(h.Sum([]byte("")))
 }
 
 // HmacSha512 return the hmac hash of string use sha512.
 // Play: https://go.dev/play/p/59Od6m4A0Ud
-func HmacSha512(data, key string) string {
+func HmacSha512(str, key string) string {
 	h := hmac.New(sha512.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return hex.EncodeToString(h.Sum([]byte("")))
 }
 
-// HmacSha512 return the hmac hash of string use sha512 with base64..
+// HmacSha512WithBase64 return the hmac hash of string use sha512 with base64.
 // Play: https://go.dev/play/p/61wBBOKO-GH
-func HmacSha512WithBase64(data, key string) string {
+func HmacSha512WithBase64(str, key string) string {
 	h := hmac.New(sha512.New, []byte(key))
-	h.Write([]byte(data))
+	h.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(h.Sum([]byte("")))
 }
 
 // Sha1 return the sha1 value (SHA-1 hash algorithm) of string.
 // Play: https://go.dev/play/p/_m_uoD1deMT
-func Sha1(data string) string {
+func Sha1(str string) string {
 	sha1 := sha1.New()
-	sha1.Write([]byte(data))
+	sha1.Write([]byte(str))
 	return hex.EncodeToString(sha1.Sum([]byte("")))
 }
 
-// Sha1 return the sha1 value (SHA-1 hash algorithm) of base64 string.
+// Sha1WithBase64 return the sha1 value (SHA-1 hash algorithm) of base64 string.
 // Play: todo
-func Sha1WithBase64(data string) string {
+func Sha1WithBase64(str string) string {
 	sha1 := sha1.New()
-	sha1.Write([]byte(data))
+	sha1.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(sha1.Sum([]byte("")))
 }
 
 // Sha256 return the sha256 value (SHA256 hash algorithm) of string.
 // Play: https://go.dev/play/p/tU9tfBMIAr1
-func Sha256(data string) string {
+func Sha256(str string) string {
 	sha256 := sha256.New()
-	sha256.Write([]byte(data))
+	sha256.Write([]byte(str))
 	return hex.EncodeToString(sha256.Sum([]byte("")))
 }
 
-// Sha256 return the sha256 value (SHA256 hash algorithm) of base64 string.
+// Sha256WithBase64 return the sha256 value (SHA256 hash algorithm) of base64 string.
 // Play: https://go.dev/play/p/85IXJHIal1k
-func Sha256WithBase64(data string) string {
+func Sha256WithBase64(str string) string {
 	sha256 := sha256.New()
-	sha256.Write([]byte(data))
+	sha256.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(sha256.Sum([]byte("")))
 }
 
 // Sha512 return the sha512 value (SHA512 hash algorithm) of string.
 // Play: https://go.dev/play/p/3WsvLYZxsHa
-func Sha512(data string) string {
+func Sha512(str string) string {
 	sha512 := sha512.New()
-	sha512.Write([]byte(data))
+	sha512.Write([]byte(str))
 	return hex.EncodeToString(sha512.Sum([]byte("")))
 }
 
-// Sha512 return the sha512 value (SHA512 hash algorithm) of base64 string.
+// Sha512WithBase64 return the sha512 value (SHA512 hash algorithm) of base64 string.
 // Play: https://go.dev/play/p/q_fY2rA-k5I
-func Sha512WithBase64(data string) string {
+func Sha512WithBase64(str string) string {
 	sha512 := sha512.New()
-	sha512.Write([]byte(data))
+	sha512.Write([]byte(str))
 	return base64.StdEncoding.EncodeToString(sha512.Sum([]byte("")))
 }