From 90f716757eca89f71d98f33481fdf2100b64ce96 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 --- .../plugin/webhook/config/apis/webhookadmission/v1alpha1/doc.go | 2 +- pkg/apis/apiserver/doc.go | 2 +- pkg/apis/apiserver/v1alpha1/doc.go | 2 +- pkg/apis/audit/doc.go | 1 + pkg/apis/audit/v1/doc.go | 1 + pkg/apis/audit/v1alpha1/doc.go | 1 + pkg/apis/audit/v1beta1/doc.go | 1 + pkg/apis/example/doc.go | 2 +- pkg/apis/example/v1/doc.go | 1 + pkg/apis/example2/v1/doc.go | 1 + 10 files changed, 10 insertions(+), 4 deletions(-) diff --git a/pkg/admission/plugin/webhook/config/apis/webhookadmission/v1alpha1/doc.go b/pkg/admission/plugin/webhook/config/apis/webhookadmission/v1alpha1/doc.go index 04c376f77..703f467f9 100644 --- a/pkg/admission/plugin/webhook/config/apis/webhookadmission/v1alpha1/doc.go +++ b/pkg/admission/plugin/webhook/config/apis/webhookadmission/v1alpha1/doc.go @@ -17,7 +17,7 @@ limitations under the License. // +k8s:deepcopy-gen=package // +k8s:conversion-gen=k8s.io/apiserver/pkg/admission/plugin/webhook/config/apis/webhookadmission // +k8s:defaulter-gen=TypeMeta +// +groupName=apiserver.config.k8s.io // Package v1alpha1 is the v1alpha1 version of the API. -// +groupName=apiserver.config.k8s.io package v1alpha1 diff --git a/pkg/apis/apiserver/doc.go b/pkg/apis/apiserver/doc.go index a89863a35..88db1ffa6 100644 --- a/pkg/apis/apiserver/doc.go +++ b/pkg/apis/apiserver/doc.go @@ -15,7 +15,7 @@ limitations under the License. */ // +k8s:deepcopy-gen=package +// +groupName=apiserver.k8s.io // Package apiserver is the internal version of the API. -// +groupName=apiserver.k8s.io package apiserver // import "k8s.io/apiserver/pkg/apis/apiserver" diff --git a/pkg/apis/apiserver/v1alpha1/doc.go b/pkg/apis/apiserver/v1alpha1/doc.go index 7dd031a79..82ebd0c45 100644 --- a/pkg/apis/apiserver/v1alpha1/doc.go +++ b/pkg/apis/apiserver/v1alpha1/doc.go @@ -17,7 +17,7 @@ limitations under the License. // +k8s:deepcopy-gen=package // +k8s:conversion-gen=k8s.io/apiserver/pkg/apis/apiserver // +k8s:defaulter-gen=TypeMeta +// +groupName=apiserver.k8s.io // Package v1alpha1 is the v1alpha1 version of the API. -// +groupName=apiserver.k8s.io package v1alpha1 // import "k8s.io/apiserver/pkg/apis/apiserver/v1alpha1" diff --git a/pkg/apis/audit/doc.go b/pkg/apis/audit/doc.go index 34bc671e8..deda9cbd6 100644 --- a/pkg/apis/audit/doc.go +++ b/pkg/apis/audit/doc.go @@ -16,4 +16,5 @@ limitations under the License. // +k8s:deepcopy-gen=package // +groupName=audit.k8s.io + package audit // import "k8s.io/apiserver/pkg/apis/audit" diff --git a/pkg/apis/audit/v1/doc.go b/pkg/apis/audit/v1/doc.go index 9d9362548..b8f818ffd 100644 --- a/pkg/apis/audit/v1/doc.go +++ b/pkg/apis/audit/v1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=audit.k8s.io + package v1 // import "k8s.io/apiserver/pkg/apis/audit/v1" diff --git a/pkg/apis/audit/v1alpha1/doc.go b/pkg/apis/audit/v1alpha1/doc.go index 27cc4c5ea..d2cbdd991 100644 --- a/pkg/apis/audit/v1alpha1/doc.go +++ b/pkg/apis/audit/v1alpha1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=audit.k8s.io + package v1alpha1 // import "k8s.io/apiserver/pkg/apis/audit/v1alpha1" diff --git a/pkg/apis/audit/v1beta1/doc.go b/pkg/apis/audit/v1beta1/doc.go index 388147258..d43a807c3 100644 --- a/pkg/apis/audit/v1beta1/doc.go +++ b/pkg/apis/audit/v1beta1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=audit.k8s.io + package v1beta1 // import "k8s.io/apiserver/pkg/apis/audit/v1beta1" diff --git a/pkg/apis/example/doc.go b/pkg/apis/example/doc.go index 2676eee81..d8b341a39 100644 --- a/pkg/apis/example/doc.go +++ b/pkg/apis/example/doc.go @@ -16,7 +16,7 @@ limitations under the License. // +k8s:deepcopy-gen=package // +groupName=example.k8s.io -// + // package example contains an example API used to demonstrate how to create api groups. Moreover, this is // used within tests. package example // import "k8s.io/apiserver/pkg/apis/example" diff --git a/pkg/apis/example/v1/doc.go b/pkg/apis/example/v1/doc.go index 4b22d37fb..33a3ef04b 100644 --- a/pkg/apis/example/v1/doc.go +++ b/pkg/apis/example/v1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=example.apiserver.k8s.io + package v1 // import "k8s.io/apiserver/pkg/apis/example/v1" diff --git a/pkg/apis/example2/v1/doc.go b/pkg/apis/example2/v1/doc.go index 5784d44f3..862536558 100644 --- a/pkg/apis/example2/v1/doc.go +++ b/pkg/apis/example2/v1/doc.go @@ -21,4 +21,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +groupName=example2.apiserver.k8s.io + package v1 // import "k8s.io/apiserver/pkg/apis/example2/v1"