doc: add comments to fix linter

Signed-off-by: Boris Glimcher <[email protected]>

spdk/accel.service.go

@@ -8,6 +8,7 @@ import (
 	"context"
 )
 
+// AccelService is interface to all acceleration functions in spdk
 type AccelService interface {
 	CryptoKeyCreate(ctx context.Context, name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error)
 	CryptoKeyDestroy(context.Context, *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error)

spdk/accel.service.impl.go

@@ -11,15 +11,21 @@ import (
 	"log"
 )
 
+// AccelServiceImpl implements AccelService interface
 type AccelServiceImpl struct {
 	client JSONRPC
 }
 
-func NewAccelService() AccelService {
+// build time check that struct implements interface
+var _ AccelService = (*AccelServiceImpl)(nil)
+
+// NewAccelService is a constructor for AccelServiceImpl
+func NewAccelService() *AccelServiceImpl {
 	// client := spdk.NewSpdkJSONRPC(spdkAddress)
 	return &AccelServiceImpl{nil}
 }
 
+// CryptoKeyCreate creates crypto key
 func (p *AccelServiceImpl) CryptoKeyCreate(ctx context.Context, name string, cipher string, key []byte) (*AccelCryptoKeyCreateResult, error) {
 	// TBD
 	keyHalf := len(key) / 2
@@ -44,17 +50,20 @@ func (p *AccelServiceImpl) CryptoKeyCreate(ctx context.Context, name string, cip
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) CryptoKeyDestroy(_ context.Context, params *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error) {
+// CryptoKeyDestroy destroys crypto key
+func (p *AccelServiceImpl) CryptoKeyDestroy(_ context.Context, _ *AccelCryptoKeyDestroyParams) (*AccelCryptoKeyDestroyResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) CryptoKeyList(_ context.Context, params *AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error) {
+// CryptoKeyList lists crypto keys
+func (p *AccelServiceImpl) CryptoKeyList(_ context.Context, _ *AccelCryptoKeyGetParams) (*AccelCryptoKeyGetResult, error) {
 	// TBD
 	return nil, nil
 }
 
-func (p *AccelServiceImpl) GetStats(_ context.Context, params *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error) {
+// GetStats gets crypto key stats
+func (p *AccelServiceImpl) GetStats(_ context.Context, _ *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error) {
 	// TBD
 	return nil, nil
 }

spdk/lvol.service.go

@@ -8,6 +8,7 @@ import (
 	"context"
 )
 
+// LvolService is interface to all logical volumes functions in spdk
 type LvolService interface {
 	CreateLvstore(context.Context, *NvmfCreateSubsystemParams) (*NvmfCreateSubsystemResult, error)
 	DeleteLvstore(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)

spdk/nvmf.service.go

@@ -8,6 +8,7 @@ import (
 	"context"
 )
 
+// NvmfService is interface to all nvme over fabric functions in spdk
 type NvmfService interface {
 	CreateSubsystem(ctx context.Context, nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error)
 	DeleteSubsystem(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error)

spdk/nvmf.service.impl.go

@@ -10,15 +10,21 @@ import (
 	"log"
 )
 
+// NvmfServiceImpl implements NvmfService interface
 type NvmfServiceImpl struct {
 	client JSONRPC
 }
 
-func NewNvmfService() NvmfService {
+// build time check that struct implements interface
+var _ NvmfService = (*NvmfServiceImpl)(nil)
+
+// NewNvmfService is a constructor for NvmfServiceImpl
+func NewNvmfService() *NvmfServiceImpl {
 	// client := spdk.NewSpdkJSONRPC(spdkAddress)
 	return &NvmfServiceImpl{nil}
 }
 
+// CreateSubsystem creates nvme subsystem
 func (p *NvmfServiceImpl) CreateSubsystem(ctx context.Context, nqn string, serial string, model string, ns int) (*NvmfCreateSubsystemResult, error) {
 	// TBD
 	params := NvmfCreateSubsystemParams{
@@ -43,36 +49,43 @@ func (p *NvmfServiceImpl) CreateSubsystem(ctx context.Context, nqn string, seria
 	return nil, nil
 }
 
+// DeleteSubsystem deletes nvme subsystem
 func (p *NvmfServiceImpl) DeleteSubsystem(context.Context, *NvmfDeleteSubsystemParams) (*NvmfDeleteSubsystemResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// GetSubsystems gets nvme subsystem
 func (p *NvmfServiceImpl) GetSubsystems(_ context.Context, page int, limit int) (*NvmfGetSubsystemsResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// GetStats gets nvme subsystem stats
 func (p *NvmfServiceImpl) GetStats(_ context.Context, page int, limit int) (*NvmfGetSubsystemStatsResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// AddListener adds nvme listener
 func (p *NvmfServiceImpl) AddListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// RemoveListener removes nvme listener
 func (p *NvmfServiceImpl) RemoveListener(context.Context, *NvmfSubsystemAddListenerParams) (*NvmfSubsystemAddListenerResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// AddNamespace adds nvme namespace
 func (p *NvmfServiceImpl) AddNamespace(context.Context, *NvmfSubsystemAddNsParams) (*NvmfSubsystemAddNsResult, error) {
 	// TBD
 	return nil, nil
 }
 
+// RemoveNamespace removes nvme namespace
 func (p *NvmfServiceImpl) RemoveNamespace(context.Context, *NvmfSubsystemRemoveNsParams) (*NvmfSubsystemRemoveNsResult, error) {
 	// TBD
 	return nil, nil