Update comments

Author: iyangsj

bfe_balance/backend/health_check.go

@@ -180,7 +180,7 @@ func checkHTTPConnect(backend *BfeBackend, checkConf *cluster_conf.BackendCheck)
 	return cluster_conf.MatchStatusCode(statusCode, *checkConf.StatusCode)
 }
 
-// CheckRedirect check whether backend server become available.
+// CheckConnect checks whether backend server become available.
 func CheckConnect(backend *BfeBackend, checkConf *cluster_conf.BackendCheck) (bool, error) {
 	switch *checkConf.Schem {
 	case "http":

bfe_balance/bal_table.go

@@ -125,12 +125,11 @@ func (t *BalTable) gslbInit(gslbConfs gslb_conf.GslbConf) error {
 	t.versions.GslbConfTimeStamp = *gslbConfs.Ts
 	t.versions.GslbConfSrc = *gslbConfs.Hostname
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in ClusterTable.gslbInit() for [%s]",
 			strings.Join(fails, ","))
 	}
+	return nil
 }
 
 func (t *BalTable) backendInit(backendConfs cluster_table_conf.ClusterTableConf) error {
@@ -159,12 +158,11 @@ func (t *BalTable) backendInit(backendConfs cluster_table_conf.ClusterTableConf)
 	// update versions
 	t.versions.ClusterTableConfVer = *backendConfs.Version
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in ClusterTable.backendInit() for [%s]",
 			strings.Join(fails, ","))
 	}
+	return nil
 }
 
 // SetGslbBasic sets gslb basic conf (from server data conf) for BalTable.
@@ -244,11 +242,10 @@ func (t *BalTable) BalTableReload(gslbConfs gslb_conf.GslbConf,
 
 	t.lock.Unlock()
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in BalTableReload() for [%s]", strings.Join(fails, ","))
 	}
+	return nil
 }
 
 func (t *BalTable) lookup(clusterName string) (*bal_gslb.BalanceGslb, error) {

bfe_basic/action/action.go

@@ -62,7 +62,7 @@ type Action struct {
 	Params []string // params of action
 }
 
-// UnmarshalJson decodes given data in json format
+// UnmarshalJSON decodes given data in json format
 func (ac *Action) UnmarshalJSON(data []byte) error {
 	var actionFile ActionFile
 

bfe_basic/action/action_query.go

@@ -115,7 +115,7 @@ func ReqQueryRename(req *bfe_basic.Request, oldName string, newName string) {
 	req.HttpRequest.URL.RawQuery = rawQuery[1:]
 }
 
-// ReqQueryRename deletes some keys from query
+// ReqQueryDel deletes some keys from query
 func ReqQueryDel(req *bfe_basic.Request, keys []string) {
 	// add "&" prefix and suffix to simplify process
 	rawQuery := "&" + req.HttpRequest.URL.RawQuery + "&"

bfe_basic/common.go

@@ -47,7 +47,7 @@ func CreateInternalSrvErrResp(request *Request) *bfe_http.Response {
 	return CreateInternalResp(request, bfe_http.StatusInternalServerError)
 }
 
-// CreateInternalSrvErrResp returns a HTTP 403 response
+// CreateForbiddenResp returns a HTTP 403 response
 func CreateForbiddenResp(request *Request) *bfe_http.Response {
 	return CreateInternalResp(request, bfe_http.StatusForbidden)
 }

bfe_basic/condition/parser/walk.go

@@ -16,7 +16,7 @@
 
 package parser
 
-// A Visitor's Visit method is invoked for each node encountered by Walk.
+// Visitor wraps the Visit method which is invoked for each node encountered by Walk.
 // If the result visitor w is not nil, Walk visits each of the children
 // of node with the visitor w, followed by a call of w.Visit(nil).
 type Visitor interface {

bfe_basic/request.go

@@ -156,9 +156,8 @@ func (req *Request) SetRequestTransport(backend *backend.BfeBackend,
 func (req *Request) Protocol() string {
 	if req.Session.IsSecure {
 		return req.Session.Proto
-	} else {
-		return req.HttpRequest.Proto
 	}
+	return req.HttpRequest.Proto
 }
 
 func (r *Request) AddTags(name string, ntags []string) {

bfe_config/bfe_cluster_conf/cluster_conf/cluster_conf_load.go

@@ -90,7 +90,7 @@ type HashConf struct {
 	SessionSticky *bool
 }
 
-// Cluster conf for Gslb
+// GslbBasicConf is basic conf for Gslb
 type GslbBasicConf struct {
 	CrossRetry *int // retry cross sub clusters
 	RetryMax   *int // inner cluster retry
@@ -111,7 +111,7 @@ type ClusterBasicConf struct {
 	CancelOnClientClose *bool // cancel blocking operation on server if client connection disconnected
 }
 
-// ClusterBasicConf is conf of cluster.
+// ClusterConf is conf of cluster.
 type ClusterConf struct {
 	BackendConf  *BackendBasic     // backend's basic conf
 	CheckConf    *BackendCheck     // how to check backend
@@ -222,7 +222,7 @@ func MatchStatusCode(statusCodeGet int, statusCodeExpect int) (bool, error) {
 		statusCodeGet, convertStatusCode(statusCodeExpect))
 }
 
-// BackendBasicCheck check BackendCheck config.
+// BackendCheckCheck check BackendCheck config.
 func BackendCheckCheck(conf *BackendCheck) error {
 	if conf.Schem == nil {
 		// set default schem to http
@@ -337,7 +337,7 @@ func HashConfCheck(conf *HashConf) error {
 	return nil
 }
 
-// ClusterToConf check ClusterBasicConf.
+// ClusterBasicConfCheck check ClusterBasicConf.
 func ClusterBasicConfCheck(conf *ClusterBasicConf) error {
 	if conf.TimeoutReadClientAgain == nil ||
 		conf.TimeoutReadClient == nil ||
@@ -365,7 +365,7 @@ func ClusterBasicConfCheck(conf *ClusterBasicConf) error {
 	return nil
 }
 
-// ClusterBasicConfCheck check ClusterConf.
+// ClusterConfCheck check ClusterConf.
 func ClusterConfCheck(conf *ClusterConf) error {
 	var err error
 

bfe_config/bfe_route_conf/route_rule_conf/route_table_load.go

@@ -42,7 +42,7 @@ type RouteRuleFile struct {
 type RouteRules []RouteRule
 type RouteRuleFiles []RouteRuleFile
 
-// ProductRule holds mapping from product to rules.
+// ProductRouteRule holds mapping from product to rules.
 type ProductRouteRule map[string]RouteRules
 type ProductRouteRuleFile map[string]RouteRuleFiles
 

bfe_config/bfe_tls_conf/session_ticket_key_conf/session_ticket_key_conf.go

@@ -31,7 +31,7 @@ const (
 	RAW_SESSION_TICKET_KEY_SIZE = 48 // bytes
 )
 
-// config for session ticket key
+// SessionTicketKeyConf is session ticket key config.
 type SessionTicketKeyConf struct {
 	Version          string // version of config
 	SessionTicketKey string // session ticket key (hex encode)