mirrors/node-feature-discovery
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/node-feature-discovery.git synced 2024-12-15 17:50:49 +00:00
Code Activity

pkg/apis/nfd/v1alpha1: document exported symbols

Browse source 
Add missing comments and fix some existing ones.
This commit is contained in:
Markus Lehtonen 2021-12-01 10:43:12 +02:00
parent c4f7ab0abe
commit d07400206f
3 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
pkg/apis/nfd/v1alpha1/doc.go
View file

@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Package v1alpha1 is the v1alpha1 version of the nfd API.
// +k8s:deepcopy-gen=package
// +kubebuilder:object:generate=true
// +groupName=nfd.k8s-sigs.io

5
pkg/apis/nfd/v1alpha1/register.go
View file

@ -23,14 +23,17 @@ import (
)
var (
// GroupVersion is group version used to register these objects
// SchemeGroupVersion is group version used to register these objects
SchemeGroupVersion = schema.GroupVersion{Group: "nfd.k8s-sigs.io", Version: "v1alpha1"}
// SchemeBuilder is the scheme builder for this API.
SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
// AddToScheme is a function to register this API group and version to a scheme.
AddToScheme = SchemeBuilder.AddToScheme
)
// Resource takes an unqualified resource name and returns a Group qualified GroupResource.
func Resource(resource string) schema.GroupResource {
return SchemeGroupVersion.WithResource(resource).GroupResource()
}

6
pkg/apis/nfd/v1alpha1/types.go
View file

@ -156,8 +156,8 @@ const (
// MatchIn returns true if any of the values stored in the expression is
// equal to the input.
MatchIn MatchOp = "In"
// MatchIn returns true if none of the values in the expression are equal
// to the input.
// MatchNotIn returns true if none of the values in the expression are
// equal to the input.
MatchNotIn MatchOp = "NotIn"
// MatchInRegexp treats values of the expression as regular expressions and
// returns true if any of them matches the input.
@ -186,7 +186,7 @@ const (
// MatchIsTrue returns true if the input holds the value "true". The
// expression must not have any values.
MatchIsTrue MatchOp = "IsTrue"
// MatchIsTrue returns true if the input holds the value "false". The
// MatchIsFalse returns true if the input holds the value "false". The
// expression must not have any values.
MatchIsFalse MatchOp = "IsFalse"
)