websocket: Add a bit of API doc

Author: cfergeau

pkg/crc/api/websocket/endpoint.go

@@ -5,6 +5,9 @@ import (
 	"sync"
 )
 
+// websocket endpoint such as "/status". It has a number of clients connected
+// to it, and works together with an EndpointHandler to listen for the data to
+// send to its clients.
 type Endpoint interface {
 	addClient(client *wsClient)
 	deleteClient(client *wsClient)

pkg/crc/api/websocket/handler.go

@@ -4,6 +4,8 @@ import (
 	"io"
 )
 
+// An EndpointHandler tells a set of listeners when they should be generating
+// data for sending to clients.
 type EndpointHandler struct {
 	listeners  []ConnectionListener
 	dataSender io.Writer

pkg/crc/api/websocket/status.go

@@ -11,6 +11,8 @@ import (
 
 type genData func() (interface{}, error)
 
+// A data generator for a websocket endpoint. It will fetch data at regular intervals, and
+// send it to all clients connected to the endpoint.
 type TickListener struct {
 	done       chan bool
 	generator  genData