Merge pull request #183 from chaosi-zju/staticcheck2

chore: format code about exported function should have comment

Author: karmada-bot

cmd/api/app/options/options.go

@@ -39,6 +39,7 @@ type Options struct {
 	OpenAPIEnabled                bool
 }
 
+// NewOptions returns initialized Options.
 func NewOptions() *Options {
 	return &Options{}
 }

cmd/api/app/types/api/v1/config.go

@@ -18,6 +18,7 @@ package v1
 
 import "github.com/karmada-io/dashboard/pkg/config"
 
+// SetDashboardConfigRequest is the request for setting dashboard config
 type SetDashboardConfigRequest struct {
 	DockerRegistries []config.DockerRegistry `json:"docker_registries"`
 	ChartRegistries  []config.ChartRegistry  `json:"chart_registries"`

cmd/api/app/types/common/response.go

@@ -22,6 +22,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
+// BaseResponse is the base response
 type BaseResponse struct {
 	Code int         `json:"code"`
 	Msg  string      `json:"message"`
@@ -38,6 +39,7 @@ func Fail(c *gin.Context, err error) {
 	Response(c, err, nil)
 }
 
+// Response generate response
 func Response(c *gin.Context, err error, data interface{}) {
 	code := 200          // biz status code
 	message := "success" // biz status message

cmd/metrics-scraper/app/options/options.go

@@ -39,6 +39,7 @@ type Options struct {
 	OpenAPIEnabled                bool
 }
 
+// NewOptions returns initialized Options.
 func NewOptions() *Options {
 	return &Options{}
 }

cmd/metrics-scraper/app/routes/metrics/handler.go

@@ -26,6 +26,7 @@ import (
 
 var requests = make(chan scrape.SaveRequest)
 
+// GetMetrics returns the metrics for the given app name
 func GetMetrics(c *gin.Context) {
 	appName := c.Param("app_name")
 	queryType := c.Query("type")

cmd/metrics-scraper/app/routes/metrics/handlerqueries.go

@@ -29,11 +29,13 @@ import (
 	"github.com/karmada-io/dashboard/cmd/metrics-scraper/app/scrape"
 )
 
+// MetricInfo represents the information about a metric.
 type MetricInfo struct {
 	Help string `json:"help"`
 	Type string `json:"type"`
 }
 
+// QueryMetrics handles the querying of metrics.
 func QueryMetrics(c *gin.Context) {
 	appName := c.Param("app_name")
 	podName := c.Param("pod_name")

cmd/metrics-scraper/app/scrape/job.go

@@ -34,14 +34,15 @@ import (
 	"github.com/karmada-io/dashboard/pkg/client"
 )
 
-// Define a struct for save requests
+// SaveRequest Define a struct for save requests
 type SaveRequest struct {
 	appName string
 	podName string
 	data    *db.ParsedData
 	result  chan error
 }
 
+// FetchMetrics fetches metrics from all pods of the given app name
 func FetchMetrics(ctx context.Context, appName string, requests chan SaveRequest) (map[string]*db.ParsedData, []string, error) {
 	kubeClient := client.InClusterClient()
 	podsMap, errors := getKarmadaPods(ctx, appName) // Pass context here

cmd/metrics-scraper/app/scrape/scrape.go

@@ -79,6 +79,7 @@ func startAppMetricsFetcher(appName string) {
 	}
 }
 
+// CheckAppStatus checks the status of all registered apps and returns a map of app names to their status.
 func CheckAppStatus(c *gin.Context) {
 	statusMap := make(map[string]bool)
 
@@ -107,6 +108,8 @@ func CheckAppStatus(c *gin.Context) {
 	c.JSON(http.StatusOK, statusMap)
 }
 
+// HandleSyncOperation handles the sync operation for a specific app
+// if not specified, it handles the sync operation for all apps.
 func HandleSyncOperation(c *gin.Context, appName string, syncValue int, queryType string) {
 	if appName == "" {
 		// Stop all apps
@@ -188,6 +191,7 @@ func HandleSyncOperation(c *gin.Context, appName string, syncValue int, queryTyp
 	}
 }
 
+// InitDatabase initializes the database and starts the metrics fetchers.
 func InitDatabase() {
 	// Initialize contexts and cancel functions
 	appContexts = make(map[string]context.Context)

cmd/web/app/options/options.go

@@ -35,6 +35,7 @@ type Options struct {
 	DashboardConfigPath string
 }
 
+// NewOptions creates a new Options object with default parameters.
 func NewOptions() *Options {
 	return &Options{}
 }

pkg/client/auth.go

@@ -82,6 +82,7 @@ func buildAuthInfo(request *http.Request) (*clientcmdapi.AuthInfo, error) {
 	return authInfo, nil
 }
 
+// HasAuthorizationHeader checks if the request has an authorization header.
 func HasAuthorizationHeader(req *http.Request) bool {
 	header := req.Header.Get(authorizationHeader)
 	if len(header) == 0 {
@@ -92,11 +93,13 @@ func HasAuthorizationHeader(req *http.Request) bool {
 	return strings.HasPrefix(header, authorizationTokenPrefix) && len(token) > 0
 }
 
+// GetBearerToken returns the bearer token from the authorization header.
 func GetBearerToken(req *http.Request) string {
 	header := req.Header.Get(authorizationHeader)
 	return extractBearerToken(header)
 }
 
+// SetAuthorizationHeader sets the authorization header for the given request.
 func SetAuthorizationHeader(req *http.Request, token string) {
 	req.Header.Set(authorizationHeader, authorizationTokenPrefix+token)
 }