style(logger): add code doc strings

mboersma · mboersma · commit 992d4095c5a2 · 2014-11-04T13:46:56.000-07:00
diff --git a/logger/syslog/message.go b/logger/syslog/message.go
@@ -5,6 +5,7 @@ import (
 	"strings"
 )
 
+// SyslogMessage is a textual system log message.
 type SyslogMessage interface {
 	fmt.Stringer
 }
diff --git a/logger/syslogd/syslogd.go b/logger/syslogd/syslogd.go
@@ -90,6 +90,7 @@ func (h *handler) mainLoop() {
 	h.End()
 }
 
+// Listen starts a new syslog server which runs until it receives a signal.
 func Listen(signalChan chan os.Signal, cleanupDone chan bool) {
 	fmt.Println("Starting syslog...")
 	// Create a server with one handler and run one listen gorutine

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`	`"strings"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+// SyslogMessage is a textual system log message.`
`8`	`9`	`type SyslogMessage interface {`
`9`	`10`	`fmt.Stringer`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@ func (h *handler) mainLoop() {`
`90`	`90`	`h.End()`
`91`	`91`	`}`
`92`	`92`
	`93`	`+// Listen starts a new syslog server which runs until it receives a signal.`
`93`	`94`	`func Listen(signalChan chan os.Signal, cleanupDone chan bool) {`
`94`	`95`	`fmt.Println("Starting syslog...")`
`95`	`96`	`// Create a server with one handler and run one listen gorutine`