documentation: Adds package level comments (#2612)

* ADDED package level comments for: benchmark/, examples/helloworld/

* UPDATED code to run gofmt

* FIXED linter errors

* FIXED spelling error

* FIXED documentation based on feedback

* FIXED comment to add pointer to another file

* ADDED reference to start server

* ADDED fix to include command to start server
This commit is contained in:
Zuhayr Elahi
2019-02-21 13:05:00 -08:00
committed by Can Guler
parent 587cec03e6
commit b86a9dbd22
5 changed files with 32 additions and 0 deletions

View File

@ -16,6 +16,26 @@
* *
*/ */
/*
Package main provides a client used for benchmarking. Before running the
client, the user would need to launch the grpc server.
To start the server before running the client, you can run look for the command
under the following file:
benchmark/server/main.go
After starting the server, the client can be run. An example of how to run this
command is:
go run benchmark/client/main.go -test_name=grpc_test
If the server is running on a different port than 50051, then use the port flag
for the client to hit the server on the correct port.
An example for how to run this command on a different port can be found here:
go run benchmark/client/main.go -test_name=grpc_test -port=8080
*/
package main package main
import ( import (

View File

@ -16,6 +16,15 @@
* *
*/ */
/*
Package main provides a server used for benchmarking. It launches a server
which is listening on port 50051. An example to start the server can be found
at:
go run benchmark/server/main.go -test_name=grpc_test
After starting the server, the client can be run separately and used to test
qps and latency.
*/
package main package main
import ( import (

View File

@ -16,6 +16,7 @@
* *
*/ */
// Package stats registers stats used for creating benchmarks
package stats package stats
import ( import (

View File

@ -16,6 +16,7 @@
* *
*/ */
// Package main implements a client for Greeter service.
package main package main
import ( import (

View File

@ -18,6 +18,7 @@
//go:generate protoc -I ../helloworld --go_out=plugins=grpc:../helloworld ../helloworld/helloworld.proto //go:generate protoc -I ../helloworld --go_out=plugins=grpc:../helloworld ../helloworld/helloworld.proto
// Package main implements a server for Greeter service.
package main package main
import ( import (