From 257fe50953037536ff2ce6a7b37f7f60aef62637 Mon Sep 17 00:00:00 2001
From: mricher <maximilien.richer@insa-rennes.fr>
Date: Tue, 19 Jan 2016 16:06:59 +0100
Subject: [PATCH] Better doc
---
net/client.go | 4 ++--
net/server.go | 10 ++++------
2 files changed, 6 insertions(+), 8 deletions(-)
diff --git a/net/client.go b/net/client.go
index e1b919e..ebbce62 100644
--- a/net/client.go
+++ b/net/client.go
@@ -12,8 +12,8 @@ import (
// Connect to a peer.
//
-// Given parameters cert/key/ca are PEM-encoded array of byte
-// Closing must be defered after call
+// Given parameters cert/key/ca are PEM-encoded array of bytes.
+// Closing must be defered after call.
func Connect(addrPort string, cert, key, ca []byte) *grpc.ClientConn {
// load peer cert/key, ca as PEM buffers
peerCert, err := tls.X509KeyPair(cert, key)
diff --git a/net/server.go b/net/server.go
index e2b4e6a..dca1611 100644
--- a/net/server.go
+++ b/net/server.go
@@ -11,12 +11,12 @@ import (
"google.golang.org/grpc/grpclog"
)
-// NewServer create a new grpc server with given tls credentials.
+// NewServer creates a new grpc server with given tls credentials.
//
-// cert/key/ca are PEM-encoded array of byte
+// cert/key/ca are PEM-encoded array of bytes.
//
// The returned grpcServer must be used in association with server{} to
-// register APIs before calling Listen()
+// register APIs before calling Listen().
func NewServer(cert, key, ca []byte) *grpc.Server {
// configure gRPC
var opts []grpc.ServerOption
@@ -42,9 +42,7 @@ func NewServer(cert, key, ca []byte) *grpc.Server {
// Listen with specified server on addr:port.
//
-// addrPort is formated as 127.0.0.1:8001
-// * addr is the addr to bind to,
-// * port is the port to listen on
+// addrPort is formated as 127.0.0.1:8001.
func Listen(addrPort string, grpcServer *grpc.Server) {
// open tcp socket
lis, err := net.Listen("tcp", addrPort)
--
GitLab