docs: improve and expand function documentation

- Improve documentation for `IsCommandAvailable` function
- Enhance documentation for `ConvertToMap` function, including detailed description of arguments and return value
- Add documentation for `Float32Ptr` function
- Add documentation for `Int32Ptr` function

Signed-off-by: Bo-Yi Wu <[email protected]>

Author: appleboy

util/util.go

@@ -5,13 +5,24 @@ import (
 	"strings"
 )
 
-// IsCommandAvailable checks whether a command is available in the PATH.
+// IsCommandAvailable checks if a given command is available in the system's PATH.
+// It takes a string argument 'cmd' which represents the command to check.
+// It returns true if the command is found, otherwise false.
 func IsCommandAvailable(cmd string) bool {
 	_, err := exec.LookPath(cmd)
 	return err == nil
 }
 
-// ConvertToMap converts a slice of strings to a map.
+// ConvertToMap takes a slice of strings in the format "key=value" and converts it into a Data map.
+// Each string in the slice is split into a key and value pair using the first occurrence of the "=" character.
+// If a string does not contain the "=" character, it is ignored.
+// The resulting map contains the keys and values from the input slice.
+//
+// Args:
+//   args ([]string): A slice of strings where each string is in the format "key=value".
+//
+// Returns:
+//   Data: A map where the keys and values are derived from the input slice.
 func ConvertToMap(args []string) Data {
 	m := make(Data)
 	for _, arg := range args {
@@ -23,10 +34,14 @@ func ConvertToMap(args []string) Data {
 	return m
 }
 
+// Float32Ptr takes a float32 value and returns a pointer to that value.
+// This can be useful for passing float32 values to functions that require a pointer.
 func Float32Ptr(v float32) *float32 {
 	return &v
 }
 
+// Int32Ptr takes an int32 value and returns a pointer to that value.
+// This can be useful for passing int32 values to functions that require a pointer.
 func Int32Ptr(v int32) *int32 {
 	return &v
 }