Doc fixes

Author: AndrewBurian

event.go

@@ -34,7 +34,7 @@ func (e *Event) Type(t string) *Event {
 	return e
 }
 
-// Type sets the event's retry: field
+// Retry sets the event's retry: field
 func (e *Event) Retry(t uint64) *Event {
 	e.retry = t
 	e.bufSet = false
@@ -49,7 +49,7 @@ func (e *Event) Data(dat string) *Event {
 	return e
 }
 
-// Adds data to the event without overwriting
+// AppendData adds data to the event without overwriting
 func (e *Event) AppendData(dat string) *Event {
 	e.WriteString(dat)
 	return e
@@ -118,6 +118,8 @@ func (e *Event) Write(p []byte) (int, error) {
 	return len(p), nil
 }
 
+// WriteString adds string data to the event.
+// Equivilant to calling Write([]byte(string))
 func (e *Event) WriteString(p string) {
 	// split event on newlines
 	split := strings.Split(p, "\n")

event_factory.go

@@ -10,13 +10,13 @@ type EventFactory interface {
 	New() *Event
 }
 
-// EventIdFactory is an event factory that creates events with
+// EventIDFactory is an event factory that creates events with
 // sequential ID fields.
 // If NewFunc is set, the factory uses it to create events before setting
 // their IDs
 // If NewFunc is not set, NewFact will be used. If neither is set, a new
 // event is created from scratch
-type EventIdFactory struct {
+type EventIDFactory struct {
 	NewFact EventFactory
 	NewFunc func() *Event
 	Next    uint64

stream.go

@@ -6,6 +6,10 @@ import (
 	"sync"
 )
 
+// Stream abstracts several client connections together and allows
+// for event multiplexing and topics.
+// A stream also implements an http.Handler to easily register incoming
+// http requests as new clients.
 type Stream struct {
 	clients           list.List
 	listLock          sync.RWMutex
@@ -174,7 +178,7 @@ func (s *Stream) TopicHandler(topics []string) http.HandlerFunc {
 	}
 }
 
-// Register a function to be called when a client connects to this stream's
+// ClientConnectHook sets a function to be called when a client connects to this stream's
 // HTTP handler.
 // Only one handler may be registered. Further calls overwrite the previous.
 func (s *Stream) ClientConnectHook(fn func(*http.Request, *Client)) {