From dae7e009b0944875975a7a2d38c164a1743167dd Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Sat, 19 Mar 2016 14:04:45 -0700 Subject: [PATCH] *: godoc clean up --- clientv3/concurrency/session.go | 1 + clientv3/doc.go | 2 +- clientv3/mirror/syncer.go | 1 + error/error.go | 2 +- etcdserver/api/v3rpc/grpc.go | 1 + integration/cluster.go | 3 ++- integration/v3_barrier_test.go | 3 ++- integration/v3_double_barrier_test.go | 1 + integration/v3_election_test.go | 1 + integration/v3_grpc_test.go | 3 ++- integration/v3_lease_test.go | 3 ++- integration/v3_lock_test.go | 1 + integration/v3_queue_test.go | 3 ++- integration/v3_stm_test.go | 3 ++- integration/v3_watch_test.go | 3 ++- main.go | 1 - pkg/transport/limit_listen.go | 2 +- storage/kvstore_bench_test.go | 1 + 18 files changed, 24 insertions(+), 11 deletions(-) diff --git a/clientv3/concurrency/session.go b/clientv3/concurrency/session.go index b222d6f4d..72cd6db7a 100644 --- a/clientv3/concurrency/session.go +++ b/clientv3/concurrency/session.go @@ -11,6 +11,7 @@ // 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 concurrency import ( diff --git a/clientv3/doc.go b/clientv3/doc.go index abd340e58..49b4037bb 100644 --- a/clientv3/doc.go +++ b/clientv3/doc.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -// clientv3 is the official Go etcd client for v3. +// Package clientv3 implements the official Go etcd client for v3. // // Create client using `clientv3.New`: // diff --git a/clientv3/mirror/syncer.go b/clientv3/mirror/syncer.go index 41b3a0dcb..23e2f3424 100644 --- a/clientv3/mirror/syncer.go +++ b/clientv3/mirror/syncer.go @@ -12,6 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package mirror implements etcd mirroring operations. package mirror import ( diff --git a/error/error.go b/error/error.go index 6304ad851..c5cf8ffb4 100644 --- a/error/error.go +++ b/error/error.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -// error package describes errors in etcd project. When any change happens, +// Package error describes errors in etcd project. When any change happens, // Documentation/errorcode.md needs to be updated correspondingly. package error diff --git a/etcdserver/api/v3rpc/grpc.go b/etcdserver/api/v3rpc/grpc.go index 25d7b384a..d58fc2730 100644 --- a/etcdserver/api/v3rpc/grpc.go +++ b/etcdserver/api/v3rpc/grpc.go @@ -11,6 +11,7 @@ // 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 v3rpc import ( diff --git a/integration/cluster.go b/integration/cluster.go index bdae94153..6926974b9 100644 --- a/integration/cluster.go +++ b/integration/cluster.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_barrier_test.go b/integration/v3_barrier_test.go index 6905f67f8..817168e07 100644 --- a/integration/v3_barrier_test.go +++ b/integration/v3_barrier_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_double_barrier_test.go b/integration/v3_double_barrier_test.go index e7206dc8c..90238294f 100644 --- a/integration/v3_double_barrier_test.go +++ b/integration/v3_double_barrier_test.go @@ -11,6 +11,7 @@ // 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 integration import ( diff --git a/integration/v3_election_test.go b/integration/v3_election_test.go index 8a43e342a..fb6cb4a5e 100644 --- a/integration/v3_election_test.go +++ b/integration/v3_election_test.go @@ -11,6 +11,7 @@ // 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 integration import ( diff --git a/integration/v3_grpc_test.go b/integration/v3_grpc_test.go index 133dc3c40..21ffe6db7 100644 --- a/integration/v3_grpc_test.go +++ b/integration/v3_grpc_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_lease_test.go b/integration/v3_lease_test.go index f467cd5a5..ced45033c 100644 --- a/integration/v3_lease_test.go +++ b/integration/v3_lease_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_lock_test.go b/integration/v3_lock_test.go index c96e97c4d..6ba0ab0c0 100644 --- a/integration/v3_lock_test.go +++ b/integration/v3_lock_test.go @@ -11,6 +11,7 @@ // 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 integration import ( diff --git a/integration/v3_queue_test.go b/integration/v3_queue_test.go index 03dc89e82..7bb36331b 100644 --- a/integration/v3_queue_test.go +++ b/integration/v3_queue_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_stm_test.go b/integration/v3_stm_test.go index 06e7f5ed0..7eece8910 100644 --- a/integration/v3_stm_test.go +++ b/integration/v3_stm_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/integration/v3_watch_test.go b/integration/v3_watch_test.go index 45404629c..b5b18a877 100644 --- a/integration/v3_watch_test.go +++ b/integration/v3_watch_test.go @@ -10,7 +10,8 @@ // 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 recipe +// limitations under the License. + package integration import ( diff --git a/main.go b/main.go index d627fb080..0c18980f4 100644 --- a/main.go +++ b/main.go @@ -20,7 +20,6 @@ // This package should NOT be extended or modified in any way; to modify the // etcd binary, work in the `github.com/coreos/etcd/etcdmain` package. // - package main import "github.com/coreos/etcd/etcdmain" diff --git a/pkg/transport/limit_listen.go b/pkg/transport/limit_listen.go index 8a81a6b93..ad2bc417c 100644 --- a/pkg/transport/limit_listen.go +++ b/pkg/transport/limit_listen.go @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// Package netutil provides network utility functions, complementing the more +// Package transport provides network utility functions, complementing the more // common ones in the net package. package transport diff --git a/storage/kvstore_bench_test.go b/storage/kvstore_bench_test.go index 258010b5f..7bc9e31ca 100644 --- a/storage/kvstore_bench_test.go +++ b/storage/kvstore_bench_test.go @@ -11,6 +11,7 @@ // 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 storage import (