[#1431] node: Fix comment format

Signed-off-by: Alexander Chuprov <a.chuprov@yadro.com>

cmd/frostfs-node/config/profiler/config.go

@@ -52,7 +52,7 @@ func Address(c *config.Config) string {
 	return AddressDefault
 }
 
-// BlockRates returns the value of "block_rate" config parameter
+// BlockRate returns the value of "block_rate" config parameter
 // from "pprof" section.
 func BlockRate(c *config.Config) int {
 	s := c.Sub(subsection)

cmd/frostfs-node/object.go

@@ -117,7 +117,7 @@ func (i *delNetInfo) TombstoneLifetime() (uint64, error) {
 	return i.cfg.cfgObject.tombstoneLifetime.Load(), nil
 }
 
-// returns node owner ID calculated from configured private key.
+// LocalNodeID returns node owner ID calculated from configured private key.
 //
 // Implements method needed for Object.Delete service.
 func (i *delNetInfo) LocalNodeID() user.ID {

pkg/core/netmap/keys.go

@@ -2,6 +2,6 @@ package netmap
 
 // AnnouncedKeys is an interface of utility for working with the announced public keys of the storage nodes.
 type AnnouncedKeys interface {
-	// Checks if the key was announced by a local node.
+	// IsLocalKey checks if the key was announced by a local node.
 	IsLocalKey(key []byte) bool
 }

pkg/innerring/processors/netmap/nodevalidation/locode/deps.go

@@ -8,38 +8,38 @@ import (
 // Record is an interface of read-only
 // FrostFS LOCODE database single entry.
 type Record interface {
-	// Must return ISO 3166-1 alpha-2
+	// CountryCode must return ISO 3166-1 alpha-2
 	// country code.
 	//
 	// Must not return nil.
 	CountryCode() *locodedb.CountryCode
 
-	// Must return English short country name
+	// CountryName must return English short country name
 	// officially used by the ISO 3166
 	// Maintenance Agency (ISO 3166/MA).
 	CountryName() string
 
-	// Must return UN/LOCODE 3-character code
+	// LocationCode must return UN/LOCODE 3-character code
 	// for the location (numerals 2-9 may also
 	// be used).
 	//
 	// Must not return nil.
 	LocationCode() *locodedb.LocationCode
 
-	// Must return name of the location which
+	// LocationName must return name of the location which
 	// have been allocated a UN/LOCODE without
 	// diacritic sign.
 	LocationName() string
 
-	// Must return ISO 1-3 character alphabetic
+	// SubDivCode Must return ISO 1-3 character alphabetic
 	// and/or numeric code for the administrative
 	// division of the country concerned.
 	SubDivCode() string
 
-	// Must return subdivision name.
+	// SubDivName must return subdivision name.
 	SubDivName() string
 
-	// Must return existing continent where is
+	// Continent must return existing continent where is
 	// the location.
 	//
 	// Must not return nil.
@@ -49,7 +49,7 @@ type Record interface {
 // DB is an interface of read-only
 // FrostFS LOCODE database.
 type DB interface {
-	// Must find the record that corresponds to
+	// Get must find the record that corresponds to
 	// LOCODE and provides the Record interface.
 	//
 	// Must return an error if Record is nil.

pkg/innerring/processors/netmap/processor.go

@@ -43,7 +43,7 @@ type (
 	// of information about the node and its finalization for adding
 	// to the network map.
 	NodeValidator interface {
-		// Must verify and optionally update NodeInfo structure.
+		// VerifyAndUpdate must verify and optionally update NodeInfo structure.
 		//
 		// Must return an error if NodeInfo input is invalid.
 		// Must return an error if it is not possible to correctly

pkg/local_object_storage/shard/metrics.go

@@ -22,7 +22,7 @@ type MetricsWriter interface {
 	// SetShardID must set (update) the shard identifier that will be used in
 	// metrics.
 	SetShardID(id string)
-	// SetReadonly must set shard mode.
+	// SetMode set mode of shard.
 	SetMode(mode mode.Mode)
 	// SetContainerObjectsCount sets container object count.
 	SetContainerObjectsCount(cnrID string, objectType string, value uint64)

pkg/morph/client/actor.go

@@ -16,7 +16,7 @@ type actorProvider interface {
 	GetRPCActor() actor.RPCActor
 }
 
-// Client switches an established connection with neo-go if it is broken.
+// SwitchRPCGuardedActor switches an established connection with neo-go if it is broken.
 // This leads to an invalidation of an rpc actor within Client. That means the
 // components that are initilized with the rpc actor may unintentionally use
 // it when it is already invalidated. SwitchRPCGuardedActor is used to prevent

pkg/morph/event/container/put_notary.go

@@ -46,7 +46,7 @@ const (
 	// put container requests.
 	PutNotaryEvent = "put"
 
-	// PutNotaryEvent is an ID of notary "put named container" notification.
+	// PutNamedNotaryEvent is an ID of notary "put named container" notification.
 	PutNamedNotaryEvent = "putNamed"
 )
 

pkg/network/group.go

@@ -67,11 +67,11 @@ func (x AddressGroup) Swap(i, j int) {
 
 // MultiAddressIterator is an interface of network address group.
 type MultiAddressIterator interface {
-	// Must iterate over network addresses and pass each one
+	// IterateAddresses must iterate over network addresses and pass each one
 	// to the handler until it returns true.
 	IterateAddresses(func(string) bool)
 
-	// Must return number of addresses in group.
+	// NumberOfAddresses must return number of addresses in group.
 	NumberOfAddresses() int
 }
 

pkg/services/control/ir/server/deps.go

@@ -5,7 +5,7 @@ import control "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/control/
 // HealthChecker is component interface for calculating
 // the current health status of a node.
 type HealthChecker interface {
-	// Must calculate and return current health status of the IR application.
+	// HealthStatus must calculate and return current health status of the IR application.
 	//
 	// If status can not be calculated for any reason,
 	// control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned.

pkg/services/control/rpc.go

@@ -292,7 +292,7 @@ func ListTargetsLocalOverrides(cli *client.Client, req *ListTargetsLocalOverride
 	return wResp.message, nil
 }
 
-// RemoveChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC.
+// GetChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC.
 func GetChainLocalOverride(cli *client.Client, req *GetChainLocalOverrideRequest, opts ...client.CallOption) (*GetChainLocalOverrideResponse, error) {
 	wResp := newResponseWrapper[GetChainLocalOverrideResponse]()
 	wReq := &requestWrapper{m: req}

pkg/services/control/server/server.go

@@ -26,13 +26,13 @@ type Server struct {
 // HealthChecker is component interface for calculating
 // the current health status of a node.
 type HealthChecker interface {
-	// Must calculate and return current status of the node in FrostFS network map.
+	// NetmapStatus must calculate and return current status of the node in FrostFS network map.
 	//
 	// If status can not be calculated for any reason,
 	// control.netmapStatus_STATUS_UNDEFINED should be returned.
 	NetmapStatus() control.NetmapStatus
 
-	// Must calculate and return current health status of the node application.
+	// HealthStatus must calculate and return current health status of the node application.
 	//
 	// If status can not be calculated for any reason,
 	// control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned.

pkg/services/netmap/executor.go

@@ -26,7 +26,7 @@ type executorSvc struct {
 // NodeState encapsulates information
 // about current node state.
 type NodeState interface {
-	// Must return current node state
+	// LocalNodeInfo must return current node state
 	// in FrostFS API v2 NodeInfo structure.
 	LocalNodeInfo() (*netmap.NodeInfo, error)
 
@@ -39,7 +39,7 @@ type NodeState interface {
 // NetworkInfo encapsulates source of the
 // recent information about the FrostFS network.
 type NetworkInfo interface {
-	// Must return recent network information in FrostFS API v2 NetworkInfo structure.
+	// Dump must return recent network information in FrostFS API v2 NetworkInfo structure.
 	//
 	// If protocol version is <=2.9, MillisecondsPerBlock and network config should be unset.
 	Dump(versionsdk.Version) (*netmapSDK.NetworkInfo, error)

pkg/services/object/common/writer/distributed.go

@@ -28,7 +28,7 @@ type distributedWriter struct {
 	resetSuccessAfterOnBroadcast bool
 }
 
-// parameters and state of container Traversal.
+// Traversal parameters and state of container.
 type Traversal struct {
 	Opts []placement.Option
 

pkg/services/object/delete/service.go

@@ -27,11 +27,11 @@ type Option func(*cfg)
 type NetworkInfo interface {
 	netmap.State
 
-	// Must return the lifespan of the tombstones
+	// TombstoneLifetime must return the lifespan of the tombstones
 	// in the FrostFS epochs.
 	TombstoneLifetime() (uint64, error)
 
-	// Returns user ID of the local storage node. Result must not be nil.
+	// LocalNodeID returns user ID of the local storage node. Result must not be nil.
 	// New tombstone objects will have the result as an owner ID if removal is executed w/o a session.
 	LocalNodeID() user.ID
 }

pkg/services/object/patch/service.go

@@ -26,7 +26,7 @@ func NewService(cfg *objectwriter.Config,
 	}
 }
 
-// Put calls internal service and returns v2 object streamer.
+// Patch calls internal service and returns v2 object streamer.
 func (s *Service) Patch() (object.PatchObjectStream, error) {
 	nodeKey, err := s.Config.KeyStorage.GetKey(nil)
 	if err != nil {

pkg/services/policer/option.go

@@ -143,7 +143,7 @@ func WithPlacementBuilder(v placement.Builder) Option {
 	}
 }
 
-// WithRemoteObjectHeader returns option to set remote object header receiver of Policer.
+// WithRemoteObjectHeaderFunc returns option to set remote object header receiver of Policer.
 func WithRemoteObjectHeaderFunc(v RemoteObjectHeaderFunc) Option {
 	return func(c *cfg) {
 		c.remoteHeader = v

pkg/util/rand/rand.go

@@ -13,7 +13,7 @@ func Uint64() uint64 {
 	return source.Uint64()
 }
 
-// Uint64 returns a random uint32 value.
+// Uint32 returns a random uint32 value.
 func Uint32() uint32 {
 	return source.Uint32()
 }

pkg/util/sdnotify/sdnotify.go

@@ -24,7 +24,7 @@ var (
 	errSocketIsNotInitialized     = errors.New("socket is not initialized")
 )
 
-// Initializes socket with provided name of
+// InitSocket initializes socket with provided name of
 // environment variable.
 func InitSocket() error {
 	notifySocket := os.Getenv("NOTIFY_SOCKET")