Browse Source

Merge pull request #765 from ewohltman/fix-godoc-comments

Fix godoc style exported function comments
bwmarrin 4 years ago
parent
commit
2eedf63f8a
1 changed files with 4 additions and 1 deletions
  1. 4 1
      wsapi.go

+ 4 - 1
wsapi.go

@@ -838,11 +838,14 @@ func (s *Session) reconnect() {
 	}
 }
 
+// Close closes a websocket and stops all listening/heartbeat goroutines.
+// TODO: Add support for Voice WS/UDP
 func (s *Session) Close() error {
 	return s.CloseWithCode(websocket.CloseNormalClosure)
 }
 
-// Close closes a websocket and stops all listening/heartbeat goroutines.
+// CloseWithCode closes a websocket using the provided closeCode and stops all
+// listening/heartbeat goroutines.
 // TODO: Add support for Voice WS/UDP connections
 func (s *Session) CloseWithCode(closeCode int) (err error) {