diff --git a/tools/events/doc.go b/tools/events/doc.go new file mode 100644 index 00000000..795582b0 --- /dev/null +++ b/tools/events/doc.go @@ -0,0 +1,19 @@ +/* +Copyright 2019 The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package events has all client logic for recording and reporting +// "k8s.io/api/events/v1beta1".Event events. +package events // import "k8s.io/client-go/tools/events" diff --git a/tools/record/doc.go b/tools/record/doc.go index 657ddecb..33d5fe78 100644 --- a/tools/record/doc.go +++ b/tools/record/doc.go @@ -14,5 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Package record has all client logic for recording and reporting events. +// Package record has all client logic for recording and reporting +// "k8s.io/api/core/v1".Event events. package record // import "k8s.io/client-go/tools/record" diff --git a/tools/record/event.go b/tools/record/event.go index 159acee4..66f8bd63 100644 --- a/tools/record/event.go +++ b/tools/record/event.go @@ -132,14 +132,14 @@ type EventBroadcaster interface { Shutdown() } -// EventRecorderAdapter is a wrapper around EventRecorder implementing the -// new EventRecorder interface. +// EventRecorderAdapter is a wrapper around a "k8s.io/client-go/tools/record".EventRecorder +// implementing the new "k8s.io/client-go/tools/events".EventRecorder interface. type EventRecorderAdapter struct { recorder EventRecorder } -// NewEventRecorderAdapter returns an adapter implementing new EventRecorder -// interface. +// NewEventRecorderAdapter returns an adapter implementing the new +// "k8s.io/client-go/tools/events".EventRecorder interface. func NewEventRecorderAdapter(recorder EventRecorder) *EventRecorderAdapter { return &EventRecorderAdapter{ recorder: recorder,