From b5eaa4de673fd2223c6d38ae6360d0a575c19b3e Mon Sep 17 00:00:00 2001
From: thinkerou <thinkerou@gmail.com>
Date: Fri, 14 Sep 2018 10:26:33 +0800
Subject: [PATCH] chore: add some annotation

---
 examples/basic/main.go               | 6 +++---
 examples/custom-validation/server.go | 1 +
 examples/realtime-advanced/main.go   | 3 +++
 examples/realtime-advanced/stats.go  | 1 +
 internal/json/json.go                | 4 ++++
 internal/json/jsoniter.go            | 4 ++++
 6 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/examples/basic/main.go b/examples/basic/main.go
index 48fa7bba..1c9e0ac4 100644
--- a/examples/basic/main.go
+++ b/examples/basic/main.go
@@ -6,7 +6,7 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-var DB = make(map[string]string)
+var db = make(map[string]string)
 
 func setupRouter() *gin.Engine {
 	// Disable Console Color
@@ -21,7 +21,7 @@ func setupRouter() *gin.Engine {
 	// Get user value
 	r.GET("/user/:name", func(c *gin.Context) {
 		user := c.Params.ByName("name")
-		value, ok := DB[user]
+		value, ok := db[user]
 		if ok {
 			c.JSON(http.StatusOK, gin.H{"user": user, "value": value})
 		} else {
@@ -50,7 +50,7 @@ func setupRouter() *gin.Engine {
 		}
 
 		if c.Bind(&json) == nil {
-			DB[user] = json.Value
+			db[user] = json.Value
 			c.JSON(http.StatusOK, gin.H{"status": "ok"})
 		}
 	})
diff --git a/examples/custom-validation/server.go b/examples/custom-validation/server.go
index dea0c302..fd47cff4 100644
--- a/examples/custom-validation/server.go
+++ b/examples/custom-validation/server.go
@@ -10,6 +10,7 @@ import (
 	"gopkg.in/go-playground/validator.v8"
 )
 
+// Booking contains object which need to bind and validate data.
 type Booking struct {
 	CheckIn  time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"`
 	CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02"`
diff --git a/examples/realtime-advanced/main.go b/examples/realtime-advanced/main.go
index 1f3c8585..a16c58b0 100644
--- a/examples/realtime-advanced/main.go
+++ b/examples/realtime-advanced/main.go
@@ -13,16 +13,19 @@ func main() {
 	StartGin()
 }
 
+// ConfigRuntime sets the number of operating system threads.
 func ConfigRuntime() {
 	nuCPU := runtime.NumCPU()
 	runtime.GOMAXPROCS(nuCPU)
 	fmt.Printf("Running with %d CPUs\n", nuCPU)
 }
 
+// StartWrokers start starsWorker by goroutine.
 func StartWorkers() {
 	go statsWorker()
 }
 
+// StartGin starts gin web server with setting router.
 func StartGin() {
 	gin.SetMode(gin.ReleaseMode)
 
diff --git a/examples/realtime-advanced/stats.go b/examples/realtime-advanced/stats.go
index 4afedcb5..a6488035 100644
--- a/examples/realtime-advanced/stats.go
+++ b/examples/realtime-advanced/stats.go
@@ -50,6 +50,7 @@ func connectedUsers() uint64 {
 	return uint64(connected)
 }
 
+// Stats returns savedStats data.
 func Stats() map[string]uint64 {
 	mutexStats.RLock()
 	defer mutexStats.RUnlock()
diff --git a/internal/json/json.go b/internal/json/json.go
index 4f643c56..467dfd07 100644
--- a/internal/json/json.go
+++ b/internal/json/json.go
@@ -9,8 +9,12 @@ package json
 import "encoding/json"
 
 var (
+	// Marshal is exported by gin/json package.
 	Marshal       = json.Marshal
+	// MarshalIndent is exported by gin/json package.
 	MarshalIndent = json.MarshalIndent
+	// NewDecoder is exported by gin/json package.
 	NewDecoder    = json.NewDecoder
+	// NewEncoder is exported by gin/json package.
 	NewEncoder    = json.NewEncoder
 )
diff --git a/internal/json/jsoniter.go b/internal/json/jsoniter.go
index f1ed5bea..a6507286 100644
--- a/internal/json/jsoniter.go
+++ b/internal/json/jsoniter.go
@@ -10,8 +10,12 @@ import "github.com/json-iterator/go"
 
 var (
 	json          = jsoniter.ConfigCompatibleWithStandardLibrary
+	// Marshal is exported by gin/json package.
 	Marshal       = json.Marshal
+	// MarshalIndent is exported by gin/json package.
 	MarshalIndent = json.MarshalIndent
+	// NewDecoder is exported by gin/json package.
 	NewDecoder    = json.NewDecoder
+	// NewEncoder is exported by gin/json package.
 	NewEncoder    = json.NewEncoder
 )