Fix godoc style comments (#356)

models/broadcaster.go

@@ -20,7 +20,7 @@ type InboundStreamDetails struct {
 	Encoder        string `json:"encoder"`
 }
 
-// RTMPStreamMetadata is the raw metadata that comes in with a RTMP connection
+// RTMPStreamMetadata is the raw metadata that comes in with a RTMP connection.
 type RTMPStreamMetadata struct {
 	Width          int         `json:"width"`
 	Height         int         `json:"height"`

models/chatListener.go

@@ -1,6 +1,6 @@
 package models
 
-//ChatListener represents the listener for the chat server
+// ChatListener represents the listener for the chat server.
 type ChatListener interface {
 	ClientAdded(client Client)
 	ClientRemoved(clientID string)

models/chatMessage.go

@@ -12,7 +12,7 @@ import (
 	"mvdan.cc/xurls"
 )
 
-//ChatMessage represents a single chat message
+// ChatMessage represents a single chat message.
 type ChatMessage struct {
 	ClientID string `json:"-"`
 
@@ -24,7 +24,7 @@ type ChatMessage struct {
 	Timestamp   time.Time `json:"timestamp"`
 }
 
-//Valid checks to ensure the message is valid
+// Valid checks to ensure the message is valid.
 func (m ChatMessage) Valid() bool {
 	return m.Author != "" && m.Body != "" && m.ID != ""
 }

models/emoji.go

@@ -1,6 +1,6 @@
 package models
 
-//CustomEmoji represents an image that can be used in chat as a custom emoji
+// CustomEmoji represents an image that can be used in chat as a custom emoji.
 type CustomEmoji struct {
 	Name  string `json:"name"`
 	Emoji string `json:"emoji"`

models/nameChangeEvent.go

@@ -1,6 +1,6 @@
 package models
 
-//NameChangeEvent represents a user changing their name in chat
+// NameChangeEvent represents a user changing their name in chat.
 type NameChangeEvent struct {
 	OldName string `json:"oldName"`
 	NewName string `json:"newName"`

models/pingMessage.go

@@ -1,6 +1,6 @@
 package models
 
-//PingMessage represents a ping message between the client and server
+// PingMessage represents a ping message between the client and server.
 type PingMessage struct {
 	MessageType string `json:"type"`
 }

models/playlist.go

@@ -1,6 +1,6 @@
 package models
 
-//Segment represents a segment of the live stream
+// Segment represents a segment of the live stream.
 type Segment struct {
 	VariantIndex       int    // The bitrate variant
 	FullDiskPath       string // Where it lives on disk
@@ -8,13 +8,13 @@ type Segment struct {
 	RemoteURL          string
 }
 
-//Variant represents a single video variant and the segments that make it up
+// Variant represents a single video variant and the segments that make it up.
 type Variant struct {
 	VariantIndex int
 	Segments     map[string]*Segment
 }
 
-//GetSegmentForFilename gets the segment for the provided filename
+// GetSegmentForFilename gets the segment for the provided filename.
 func (v *Variant) GetSegmentForFilename(filename string) *Segment {
 	return v.Segments[filename]
 }

models/stats.go

@@ -4,7 +4,7 @@ import (
 	"github.com/owncast/owncast/utils"
 )
 
-//Stats holds the stats for the system
+// Stats holds the stats for the system.
 type Stats struct {
 	SessionMaxViewerCount int            `json:"sessionMaxViewerCount"`
 	OverallMaxViewerCount int            `json:"overallMaxViewerCount"`

models/status.go

@@ -2,7 +2,7 @@ package models
 
 import "github.com/owncast/owncast/utils"
 
-//Status represents the status of the system
+// Status represents the status of the system.
 type Status struct {
 	Online                bool `json:"online"`
 	ViewerCount           int  `json:"viewerCount"`

models/storageProvider.go

@@ -1,6 +1,6 @@
 package models
 
-//StorageProvider is how a chunk storage provider should be implemented
+// StorageProvider is how a chunk storage provider should be implemented.
 type StorageProvider interface {
 	Setup() error
 	Save(filePath string, retryCount int) (string, error)