add comments to variables and functions

cmd/client/commandv2/common/spec.go

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
 package common
 
 import (
  "github.com/megaease/easegress/v2/cmd/client/general"
@@ -43,6 +43,7 @@
  pipeline.Spec `json:",inline"`
 }
 
+// SetFilters sets the filters of PipelineSpec.
 func (p *PipelineSpec) SetFilters(filters []filters.Spec) {
  data := codectool.MustMarshalYAML(filters)
  maps, _ := general.UnmarshalMapInterface(data, true)

cmd/client/commandv2/convert/nginx/cmd.go

@@ -30,6 +30,7 @@ import (
  "github.com/spf13/cobra"
 )
 
+// Options contains the options for convert nginx.conf.
 type Options struct {
  NginxConf string
  Output string

cmd/client/commandv2/convert/nginx/env.go

@@ -66,12 +66,14 @@ type ServerEnv struct {
  SSLCertificateKey []*Directive `json:"ssl_certificate_key"`
 }
 
+// ProxyEnv is the environment for creating proxy.
 type ProxyEnv struct {
  Pass *Directive `json:"pass"`
  ProxySetHeader []*Directive `json:"proxy_set_header"`
  Gzip *GzipEnv `json:"gzip"`
 }
 
+// GzipEnv is the environment for creating gzip.
 type GzipEnv struct {
  Gzip *Directive `json:"gzip"`
  GzipMinLength *Directive `json:"gzip_min_length"`
@@ -107,6 +109,7 @@ func newEnv() *Env {
  return env
 }
 
+// Clone clones the environment.
 func (env *Env) Clone() (*Env, error) {
  data, err := json.Marshal(env)
  if err != nil {
@@ -121,6 +124,7 @@ func (env *Env) Clone() (*Env, error) {
  return &newEnv, nil
 }
 
+// MustClone clones the environment.
 func (env *Env) MustClone() *Env {
  newEnv, err := env.Clone()
  if err != nil {
@@ -129,6 +133,7 @@ func (env *Env) MustClone() *Env {
  return newEnv
 }
 
+// Update updates the environment.
 func (env *Env) Update(d *Directive) {
  fn, ok := env.updateFn[d.Directive]
  if ok {
@@ -141,6 +146,7 @@ func (env *Env) Update(d *Directive) {
  }
 }
 
+// GetServerInfo gets the server info from environment.
 func (env *Env) GetServerInfo() (*ServerInfo, error) {
  info := &ServerInfo{}
  info.Port = 80
@@ -186,6 +192,7 @@ func (env *Env) GetServerInfo() (*ServerInfo, error) {
  return info, nil
 }
 
+// GetProxyInfo gets the proxy info from environment.
 func (env *Env) GetProxyInfo() (*ProxyInfo, error) {
  p := env.Proxy
  if p.Pass == nil || p.Pass.Directive != "proxy_pass" {

cmd/client/commandv2/convert/nginx/parse.go

@@ -28,14 +28,23 @@ import (
 )
 
 const (
- DirectiveInclude = "include"
- DirectiveHTTP = "http"
- DirectiveServer = "server"
+ // DirectiveInclude is the include directive.
+ DirectiveInclude = "include"
+ // DirectiveHTTP is the http directive.
+ DirectiveHTTP = "http"
+ // DirectiveServer is the server directive.
+ DirectiveServer = "server"
+ // DirectiveLocation is the location directive.
  DirectiveLocation = "location"
 )
 
+// Directive is the nginx directive.
 type Directive = crossplane.Directive
+
+// Directives is the nginx directives.
 type Directives = crossplane.Directives
+
+// Payload is the nginx payload.
 type Payload = crossplane.Payload
 
 func parsePayload(payload *Payload) (*Config, error) {

cmd/client/commandv2/convert/nginx/types.go

@@ -17,10 +17,12 @@
 
 package nginx
 
+// Config is config for convert.
 type Config struct {
  Servers []*Server `json:"servers"`
 }
 
+// ServerBase is the base config for server.
 type ServerBase struct {
  Port int `json:"port"`
  Address string `json:"address"`
@@ -31,47 +33,59 @@ type ServerBase struct {
  Keys map[string]string `json:"keys"`
 }
 
+// Server is the config for server.
 type Server struct {
  ServerBase `json:",inline"`
  Rules []*Rule `json:"rules"`
 }
 
+// ServerInfo is the info config for server.
 type ServerInfo struct {
  ServerBase `json:",inline"`
  Hosts []*HostInfo `json:"hosts"`
 }
 
+// HostInfo is the info config for host.
 type HostInfo struct {
  Value string `json:"value"`
  IsRegexp bool `json:"isRegexp"`
 }
 
+// Rule is the config for rule.
 type Rule struct {
  Hosts []*HostInfo `json:"hosts"`
  Paths []*Path `json:"paths"`
 }
 
+// PathType is the type of path.
 type PathType string
 
 const (
- PathTypePrefix PathType = "prefix"
- PathTypeExact PathType = "exact"
- PathTypeRe PathType = "regexp"
+ // PathTypePrefix is the prefix type of path.
+ PathTypePrefix PathType = "prefix"
+ // PathTypeExact is the exact type of path.
+ PathTypeExact PathType = "exact"
+ // PathTypeRe is the regexp type of path.
+ PathTypeRe PathType = "regexp"
+ // PathTypeReInsensitive is the case insensitive regexp type of path.
  PathTypeReInsensitive PathType = "caseInsensitiveRegexp"
 )
 
+// Path is the config for path.
 type Path struct {
  Path string `json:"path"`
  Type PathType `json:"type"`
  Backend *ProxyInfo `json:"backend"`
 }
 
+// ProxyInfo is the config for proxy.
 type ProxyInfo struct {
  Servers []*BackendInfo `json:"servers"`
  SetHeaders map[string]string `json:"setHeaders"`
  GzipMinLength int `json:"gzipMinLength"`
 }
 
+// BackendInfo is the config for backend.
 type BackendInfo struct {
  Server string `json:"server"`
  Weight int `json:"weight"`