Add comments to exported syslog types

jszwedko · michaelshobbs · commit 5af7c79da263 · 2020-05-01T13:31:20.000-07:00
diff --git a/adapters/syslog/syslog.go b/adapters/syslog/syslog.go
@@ -29,11 +29,14 @@ var (
 	econnResetErrStr string
 )
 
+// TCPFraming represents the type of framing to use for syslog messages
 type TCPFraming string
 
 const (
-	TraditionalTCPFraming  TCPFraming = "traditional"   // LF framing
-	OctetCountedTCPFraming            = "octet-counted" // https://tools.ietf.org/html/rfc6587#section-3.4.1
+	// TraditionalTCPFraming is the traditional LF framing of syslog messages on the wire
+	TraditionalTCPFraming TCPFraming = "traditional"
+	// OctetCountedTCPFraming prepends the size of each message before the message. https://tools.ietf.org/html/rfc6587#section-3.4.1
+	OctetCountedTCPFraming = "octet-counted"
 )
 
 func init() {

Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,14 @@ var (`
`29`	`29`	`econnResetErrStr string`
`30`	`30`	`)`
`31`	`31`
	`32`	`+// TCPFraming represents the type of framing to use for syslog messages`
`32`	`33`	`type TCPFraming string`
`33`	`34`
`34`	`35`	`const (`
`35`		`- TraditionalTCPFraming TCPFraming = "traditional" // LF framing`
`36`		`- OctetCountedTCPFraming = "octet-counted" // https://tools.ietf.org/html/rfc6587#section-3.4.1`
	`36`	`+ // TraditionalTCPFraming is the traditional LF framing of syslog messages on the wire`
	`37`	`+ TraditionalTCPFraming TCPFraming = "traditional"`
	`38`	`+ // OctetCountedTCPFraming prepends the size of each message before the message. https://tools.ietf.org/html/rfc6587#section-3.4.1`
	`39`	`+ OctetCountedTCPFraming = "octet-counted"`
`37`	`40`	`)`
`38`	`41`
`39`	`42`	`func init() {`