1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2025-03-15 04:57:56 +00:00

pkg/api/feature: document exported functions

This commit is contained in:
Markus Lehtonen 2021-12-01 10:30:17 +02:00
parent 6f69b67708
commit c4f7ab0abe

View file

@ -25,6 +25,7 @@ func NewDomainFeatures() *DomainFeatures {
Instances: make(map[string]InstanceFeatureSet)} Instances: make(map[string]InstanceFeatureSet)}
} }
// NewKeyFeatures creates a new instance of KeyFeatureSet.
func NewKeyFeatures(keys ...string) KeyFeatureSet { func NewKeyFeatures(keys ...string) KeyFeatureSet {
e := make(map[string]Nil, len(keys)) e := make(map[string]Nil, len(keys))
for _, k := range keys { for _, k := range keys {
@ -33,6 +34,7 @@ func NewKeyFeatures(keys ...string) KeyFeatureSet {
return KeyFeatureSet{Elements: e} return KeyFeatureSet{Elements: e}
} }
// NewValueFeatures creates a new instance of ValueFeatureSet.
func NewValueFeatures(values map[string]string) ValueFeatureSet { func NewValueFeatures(values map[string]string) ValueFeatureSet {
if values == nil { if values == nil {
values = make(map[string]string) values = make(map[string]string)
@ -40,10 +42,12 @@ func NewValueFeatures(values map[string]string) ValueFeatureSet {
return ValueFeatureSet{Elements: values} return ValueFeatureSet{Elements: values}
} }
// NewInstanceFeatures creates a new instance of InstanceFeatureSet.
func NewInstanceFeatures(instances []InstanceFeature) InstanceFeatureSet { func NewInstanceFeatures(instances []InstanceFeature) InstanceFeatureSet {
return InstanceFeatureSet{Elements: instances} return InstanceFeatureSet{Elements: instances}
} }
// NewInstanceFeature creates a new InstanceFeature instance.
func NewInstanceFeature(attrs map[string]string) *InstanceFeature { func NewInstanceFeature(attrs map[string]string) *InstanceFeature {
if attrs == nil { if attrs == nil {
attrs = make(map[string]string) attrs = make(map[string]string)