From 33fabb1e0f42117b3ba8542040cb3e99aab753a4 Mon Sep 17 00:00:00 2001 From: Jingyi Hu Date: Tue, 4 Sep 2018 14:08:32 -0700 Subject: [PATCH] *: Remove comment tags in GoDoc Adding blank line between comment tag and package name in doc.go. So that the comment tags such as '+k8s:deepcopy-gen=package' do not show up in GoDoc. Kubernetes-commit: 61117761cd4a1b2e6ad9ff2d7eb915f3d2739dc6 --- pkg/apis/clientauthentication/doc.go | 1 + pkg/apis/clientauthentication/v1alpha1/doc.go | 1 + pkg/apis/clientauthentication/v1beta1/doc.go | 1 + pkg/version/doc.go | 3 ++- tools/clientcmd/api/doc.go | 1 + tools/clientcmd/api/v1/doc.go | 1 + 6 files changed, 7 insertions(+), 1 deletion(-) diff --git a/pkg/apis/clientauthentication/doc.go b/pkg/apis/clientauthentication/doc.go index d06482d5..b9945975 100644 --- a/pkg/apis/clientauthentication/doc.go +++ b/pkg/apis/clientauthentication/doc.go @@ -16,4 +16,5 @@ limitations under the License. // +k8s:deepcopy-gen=package // +groupName=client.authentication.k8s.io + package clientauthentication // import "k8s.io/client-go/pkg/apis/clientauthentication" diff --git a/pkg/apis/clientauthentication/v1alpha1/doc.go b/pkg/apis/clientauthentication/v1alpha1/doc.go index 016adb28..19ab7761 100644 --- a/pkg/apis/clientauthentication/v1alpha1/doc.go +++ b/pkg/apis/clientauthentication/v1alpha1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=client.authentication.k8s.io + package v1alpha1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1alpha1" diff --git a/pkg/apis/clientauthentication/v1beta1/doc.go b/pkg/apis/clientauthentication/v1beta1/doc.go index fbcd9b7f..22d1c588 100644 --- a/pkg/apis/clientauthentication/v1beta1/doc.go +++ b/pkg/apis/clientauthentication/v1beta1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=client.authentication.k8s.io + package v1beta1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1beta1" diff --git a/pkg/version/doc.go b/pkg/version/doc.go index 30399fb0..05e997e1 100644 --- a/pkg/version/doc.go +++ b/pkg/version/doc.go @@ -14,7 +14,8 @@ See the License for the specific language governing permissions and limitations under the License. */ +// +k8s:openapi-gen=true + // Package version supplies version information collected at build time to // kubernetes components. -// +k8s:openapi-gen=true package version // import "k8s.io/client-go/pkg/version" diff --git a/tools/clientcmd/api/doc.go b/tools/clientcmd/api/doc.go index 0a081871..5871575a 100644 --- a/tools/clientcmd/api/doc.go +++ b/tools/clientcmd/api/doc.go @@ -15,4 +15,5 @@ limitations under the License. */ // +k8s:deepcopy-gen=package + package api diff --git a/tools/clientcmd/api/v1/doc.go b/tools/clientcmd/api/v1/doc.go index 9750cf73..cbf29ccf 100644 --- a/tools/clientcmd/api/v1/doc.go +++ b/tools/clientcmd/api/v1/doc.go @@ -15,4 +15,5 @@ limitations under the License. */ // +k8s:deepcopy-gen=package + package v1