fix some comments (#2600)

Signed-off-by: cui fliter <imcusg@gmail.com>

cmd/gf/internal/cmd/cmd_build.go

@@ -304,7 +304,7 @@ buildDone:
 	return
 }
 
-// getBuildInVarMapJson retrieves and returns the custom build-in variables in configuration
+// getBuildInVarStr retrieves and returns the custom build-in variables in configuration
 // file as json.
 func (c cBuild) getBuildInVarStr(ctx context.Context, in cBuildInput) string {
 	buildInVarMap := in.VarMap

cmd/gf/internal/cmd/gendao/gendao_structure.go

@@ -57,7 +57,7 @@ func generateStructDefinition(ctx context.Context, in generateStructDefinitionIn
 	return buffer.String()
 }
 
-// generateStructFieldForModel generates and returns the attribute definition for specified field.
+// generateStructFieldDefinition generates and returns the attribute definition for specified field.
 func generateStructFieldDefinition(
 	ctx context.Context, field *gdb.TableField, in generateStructDefinitionInput,
 ) []string {

cmd/gf/internal/service/install.go

@@ -148,7 +148,7 @@ func (s serviceInstall) IsInstalled() (*serviceInstallAvailablePath, bool) {
 	return nil, false
 }
 
-// getGoPathBinFilePath retrieves ad returns the GOPATH/bin path for binary.
+// getGoPathBin retrieves ad returns the GOPATH/bin path for binary.
 func (s serviceInstall) getGoPathBin() string {
 	if goPath := genv.Get(`GOPATH`).String(); goPath != "" {
 		return gfile.Join(goPath, "bin")

database/gdb/gdb_func.go

@@ -226,7 +226,7 @@ func DataToMapDeep(value interface{}) map[string]interface{} {
 	return m
 }
 
-// doHandleTableName adds prefix string and quote chars for table name. It handles table string like:
+// doQuoteTableName adds prefix string and quote chars for table name. It handles table string like:
 // "user", "user u", "user,user_detail", "user u, user_detail ut", "user as u, user_detail as ut",
 // "user.user u", "`user`.`user` u".
 //

net/gclient/gclient_z_example_test.go

@@ -529,7 +529,7 @@ func ExampleClient_GetVar() {
 // http proxy server listening on `127.0.0.1:1081`
 // socks5 proxy server listening on `127.0.0.1:1080`
 func ExampleClient_SetProxy() {
-	// connect to a http proxy server
+	// connect to an http proxy server
 	client := g.Client()
 	client.SetProxy("http://127.0.0.1:1081")
 	client.SetTimeout(5 * time.Second) // it's suggested to set http client timeout
@@ -541,7 +541,7 @@ func ExampleClient_SetProxy() {
 	fmt.Println(err != nil)
 	resp.Close()
 
-	// connect to a http proxy server which needs auth
+	// connect to an http proxy server which needs auth
 	client.SetProxy("http://user:password:127.0.0.1:1081")
 	client.SetTimeout(5 * time.Second) // it's suggested to set http client timeout
 	resp, err = client.Get(ctx, "http://127.0.0.1:8999")

net/ghttp/ghttp_server_router_group.go

@@ -176,7 +176,7 @@ func (g *RouterGroup) Bind(handlerOrObject ...interface{}) *RouterGroup {
 	return group
 }
 
-// ALL register a http handler to give the route pattern and all http methods.
+// ALL register an http handler to give the route pattern and all http methods.
 func (g *RouterGroup) ALL(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(
 		groupBindTypeHandler,
@@ -200,52 +200,52 @@ func (g *RouterGroup) Map(m map[string]interface{}) {
 	}
 }
 
-// GET registers a http handler to give the route pattern and the http method: GET.
+// GET registers an http handler to give the route pattern and the http method: GET.
 func (g *RouterGroup) GET(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "GET:"+pattern, object, params...)
 }
 
-// PUT registers a http handler to give the route pattern and the http method: PUT.
+// PUT registers an http handler to give the route pattern and the http method: PUT.
 func (g *RouterGroup) PUT(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "PUT:"+pattern, object, params...)
 }
 
-// POST registers a http handler to give the route pattern and the http method: POST.
+// POST registers an http handler to give the route pattern and the http method: POST.
 func (g *RouterGroup) POST(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "POST:"+pattern, object, params...)
 }
 
-// DELETE registers a http handler to give the route pattern and the http method: DELETE.
+// DELETE registers an http handler to give the route pattern and the http method: DELETE.
 func (g *RouterGroup) DELETE(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "DELETE:"+pattern, object, params...)
 }
 
-// PATCH registers a http handler to give the route pattern and the http method: PATCH.
+// PATCH registers an http handler to give the route pattern and the http method: PATCH.
 func (g *RouterGroup) PATCH(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "PATCH:"+pattern, object, params...)
 }
 
-// HEAD registers a http handler to give the route pattern and the http method: HEAD.
+// HEAD registers an http handler to give the route pattern and the http method: HEAD.
 func (g *RouterGroup) HEAD(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "HEAD:"+pattern, object, params...)
 }
 
-// CONNECT registers a http handler to give the route pattern and the http method: CONNECT.
+// CONNECT registers an http handler to give the route pattern and the http method: CONNECT.
 func (g *RouterGroup) CONNECT(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "CONNECT:"+pattern, object, params...)
 }
 
-// OPTIONS register a http handler to give the route pattern and the http method: OPTIONS.
+// OPTIONS register an http handler to give the route pattern and the http method: OPTIONS.
 func (g *RouterGroup) OPTIONS(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "OPTIONS:"+pattern, object, params...)
 }
 
-// TRACE registers a http handler to give the route pattern and the http method: TRACE.
+// TRACE registers an http handler to give the route pattern and the http method: TRACE.
 func (g *RouterGroup) TRACE(pattern string, object interface{}, params ...interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeHandler, "TRACE:"+pattern, object, params...)
 }
 
-// REST registers a http handler to give the route pattern according to REST rule.
+// REST registers an http handler to give the route pattern according to REST rule.
 func (g *RouterGroup) REST(pattern string, object interface{}) *RouterGroup {
 	return g.Clone().preBindToLocalArray(groupBindTypeRest, pattern, object)
 }

net/goai/goai_shema_ref.go

@@ -23,7 +23,7 @@ type SchemaRef struct {
 	Value *Schema
 }
 
-// isEmbeddedStructDefine checks and returns whether given golang type is embedded struct definition, like:
+// isEmbeddedStructDefinition checks and returns whether given golang type is embedded struct definition, like:
 //
 //	struct A struct{
 //	    B struct{

os/glog/glog_logger.go

@@ -352,7 +352,7 @@ func (l *Logger) getFilePointer(ctx context.Context, path string) *gfpool.File {
 	return file
 }
 
-// getFilePointer retrieves and returns a file pointer from file pool.
+// getOpenedFilePointer retrieves and returns a file pointer from file pool.
 func (l *Logger) getOpenedFilePointer(ctx context.Context, path string) *gfpool.File {
 	file := gfpool.Get(
 		path,

os/gsession/gsession_storage_redis.go

@@ -123,7 +123,7 @@ func (s *StorageRedis) UpdateTTL(ctx context.Context, sessionId string, ttl time
 	return nil
 }
 
-// doUpdateTTL updates the TTL for session id.
+// doUpdateExpireForSession updates the TTL for session id.
 func (s *StorageRedis) doUpdateExpireForSession(ctx context.Context, sessionId string, ttlSeconds int) error {
 	intlog.Printf(ctx, "StorageRedis.doUpdateTTL: %s, %d", sessionId, ttlSeconds)
 	_, err := s.redis.Expire(ctx, s.sessionIdToRedisKey(sessionId), int64(ttlSeconds))

os/gview/gview_buildin.go

@@ -240,7 +240,7 @@ func (view *View) buildInFuncXml(value interface{}, rootTag ...string) (string,
 	return string(b), err
 }
 
-// buildInFuncXml implements build-in template function: ini ,
+// buildInFuncIni implements build-in template function: ini ,
 // which encodes and returns `value` as XML string.
 func (view *View) buildInFuncIni(value interface{}) (string, error) {
 	b, err := gjson.New(value).ToIni()

util/gvalid/gvalid_validator_check_value.go

@@ -31,7 +31,7 @@ type doCheckValueInput struct {
 	DataMap  map[string]interface{} // DataMap specifies the map that is converted from `dataRaw`. It is usually used internally
 }
 
-// doCheckSingleValue does the really rules validation for single key-value.
+// doCheckValue does the really rules validation for single key-value.
 func (v *Validator) doCheckValue(ctx context.Context, in doCheckValueInput) Error {
 	// If there's no validation rules, it does nothing and returns quickly.
 	if in.Rule == "" {