From 92f772e4b3d169aaac1ac3b94395534b1f9b6417 Mon Sep 17 00:00:00 2001 From: Gary Burd Date: Tue, 18 Jul 2017 13:21:30 -0700 Subject: [PATCH] Misc cleanup - Fix lint warnings. - Use standard comment format to mark deprecated identifiers. - Remove redundant paragraph from doc. --- doc.go | 5 ----- json.go | 11 ++++++++--- server.go | 4 ++-- util.go | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc.go b/doc.go index 505fe83..fe20927 100644 --- a/doc.go +++ b/doc.go @@ -146,11 +146,6 @@ // CheckOrigin: func(r *http.Request) bool { return true }, // } // -// We recommend the upgrader.Upgrade method to perform an upgrade -// from an HTTP connection to a websocket connection. This method performs -// origin policy checking using the CheckOrigin field associated with the -// Upgrader instance. -// // The deprecated package-level Upgrade function does not perform origin // checking. The application is responsible for checking the Origin header // before calling the Upgrade function. diff --git a/json.go b/json.go index 4f0e368..dc2c1f6 100644 --- a/json.go +++ b/json.go @@ -9,12 +9,14 @@ import ( "io" ) -// WriteJSON is deprecated, use c.WriteJSON instead. +// WriteJSON writes the JSON encoding of v as a message. +// +// Deprecated: Use c.WriteJSON instead. func WriteJSON(c *Conn, v interface{}) error { return c.WriteJSON(v) } -// WriteJSON writes the JSON encoding of v to the connection. +// WriteJSON writes the JSON encoding of v as a message. // // See the documentation for encoding/json Marshal for details about the // conversion of Go values to JSON. @@ -31,7 +33,10 @@ func (c *Conn) WriteJSON(v interface{}) error { return err2 } -// ReadJSON is deprecated, use c.ReadJSON instead. +// ReadJSON reads the next JSON-encoded message from the connection and stores +// it in the value pointed to by v. +// +// Deprecated: Use c.ReadJSON instead. func ReadJSON(c *Conn, v interface{}) error { return c.ReadJSON(v) } diff --git a/server.go b/server.go index d6e3d82..6ae97c5 100644 --- a/server.go +++ b/server.go @@ -228,10 +228,10 @@ func (u *Upgrader) Upgrade(w http.ResponseWriter, r *http.Request, responseHeade return c, nil } -// Deprecated: Use websocket.Upgrader instead. -// // Upgrade upgrades the HTTP server connection to the WebSocket protocol. // +// Deprecated: Use websocket.Upgrader instead. +// // Upgrade does not perform origin checking. The application is responsible for // checking the Origin header before calling Upgrade. An example implementation // of the same origin policy check is: diff --git a/util.go b/util.go index 9a4908d..262e647 100644 --- a/util.go +++ b/util.go @@ -111,14 +111,14 @@ func nextTokenOrQuoted(s string) (value string, rest string) { case escape: escape = false p[j] = b - j += 1 + j++ case b == '\\': escape = true case b == '"': return string(p[:j]), s[i+1:] default: p[j] = b - j += 1 + j++ } } return "", ""