fix up package docs

Edgio · Apr 26, 2017 · c3511e0 · c3511e0
1 parent 9fd5d66
commit c3511e0
Show file tree

Hide file tree

Showing 53 changed files with 60 additions and 29 deletions.
diff --git a/disc/disc.go b/disc/disc.go
@@ -1,4 +1,3 @@
-// Package discovery handles finding vFlow nodes through multicasting
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,8 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
+// Package discovery handles finding vFlow nodes through multicasting
 package discovery
 
 import (

diff --git a/ipfix/decoder.go b/ipfix/decoder.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/decoder_test.go b/ipfix/decoder_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/doc.go b/ipfix/doc.go
@@ -0,0 +1,2 @@
+// Package ipfix decodes IPFIX packets
+package ipfix
diff --git a/ipfix/interpret.go b/ipfix/interpret.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/marshal.go b/ipfix/marshal.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/marshal_test.go b/ipfix/marshal_test.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/memcache.go b/ipfix/memcache.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/memcache_rpc.go b/ipfix/memcache_rpc.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/memcache_test.go b/ipfix/memcache_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 import (

diff --git a/ipfix/rfc5102_model.go b/ipfix/rfc5102_model.go
@@ -1,4 +1,3 @@
-// Package ipfix decodes IPFIX packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package ipfix
 
 // FieldType is IPFIX Abstract Data Types RFC5102#section-3.1

diff --git a/mirror/doc.go b/mirror/doc.go
@@ -0,0 +1,2 @@
+// Package mirror replicates the IPFIX packets with spoofing feature to 3rd party collector
+package mirror
diff --git a/mirror/mirror.go b/mirror/mirror.go
@@ -20,7 +20,6 @@
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
 
-// Package mirror replicates the IPFIX packets with spoofing feature to 3rd party collector
 package mirror
 
 import (

diff --git a/mirror/mirror_test.go b/mirror/mirror_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package mirror
 
 import (

diff --git a/monitor/monitor.go b/monitor/monitor.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package main
 
 import (

diff --git a/monitor/store/doc.go b/monitor/store/doc.go
@@ -0,0 +1,2 @@
+// Package store ingest monitoring time series data points to different back-ends
+package store
diff --git a/monitor/store/store.go b/monitor/store/store.go
@@ -20,7 +20,6 @@
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
 
-// Package store ingest monitoring time series data points to different back-ends
 package store
 
 import (

diff --git a/netflow/v9/decoder.go b/netflow/v9/decoder.go
@@ -20,7 +20,6 @@
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
 
-// Package netflow9 decodes netflow version v9 packets
 package netflow9
 
 import (

diff --git a/netflow/v9/doc.go b/netflow/v9/doc.go
@@ -0,0 +1,2 @@
+// Package netflow9 decodes netflow version v9 packets
+package netflow9
diff --git a/netflow/v9/memcache.go b/netflow/v9/memcache.go
@@ -20,7 +20,6 @@
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
 
-// Package netflow9 decodes netflow version v9 packets
 package netflow9
 
 import (

diff --git a/packet/doc.go b/packet/doc.go
@@ -0,0 +1,2 @@
+// Package packet decodes layer two, three and four OSI model layers
+package packet
diff --git a/packet/ethernet.go b/packet/ethernet.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import (

diff --git a/packet/ethernet_test.go b/packet/ethernet_test.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "testing"

diff --git a/packet/icmp.go b/packet/icmp.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "errors"

diff --git a/packet/network.go b/packet/network.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import (

diff --git a/packet/network_test.go b/packet/network_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "testing"

diff --git a/packet/packet.go b/packet/packet.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "errors"

diff --git a/packet/packet_test.go b/packet/packet_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "testing"

diff --git a/packet/transport.go b/packet/transport.go
@@ -1,4 +1,3 @@
-// Package packet decodes layer two, three and four OSI model layers
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "errors"

diff --git a/packet/transport_test.go b/packet/transport_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package packet
 
 import "testing"

diff --git a/producer/doc.go b/producer/doc.go
@@ -0,0 +1,2 @@
+// Package producer pushes decoded messages to message queues
+package producer
diff --git a/producer/kafka.go b/producer/kafka.go
@@ -1,4 +1,3 @@
-// Package producer push decoded messages to messaging queue
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package producer
 
 import (

diff --git a/producer/nsq.go b/producer/nsq.go
@@ -1,4 +1,3 @@
-// Package producer push decoded messages to messaging queue
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package producer
 
 import (

diff --git a/producer/producer.go b/producer/producer.go
@@ -1,4 +1,3 @@
-// Package producer push decoded messages to messaging queue
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package producer
 
 import (

diff --git a/producer/producer_test.go b/producer/producer_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package producer
 
 import (

diff --git a/reader/reader.go b/reader/reader.go
@@ -1,4 +1,3 @@
-// Package reader decodes a variable from buffer
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,8 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
+// Package reader decodes a variable from buffer
 package reader
 
 import (

diff --git a/reader/reader_test.go b/reader/reader_test.go
@@ -1,4 +1,3 @@
-// Package reader decodes a variable from buffer
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package reader
 
 import (

diff --git a/sflow/decoder.go b/sflow/decoder.go
@@ -1,4 +1,3 @@
-// Package sflow decodes sFlow packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package sflow
 
 import (

diff --git a/sflow/decoder_test.go b/sflow/decoder_test.go
@@ -19,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package sflow
 
 import (

diff --git a/sflow/doc.go b/sflow/doc.go
@@ -0,0 +1,2 @@
+// Package sflow decodes sFlow packets
+package sflow
diff --git a/sflow/flow_sample.go b/sflow/flow_sample.go
@@ -1,4 +1,3 @@
-// Package sflow decodes sFlow packets
 //: ----------------------------------------------------------------------------
 //: Copyright (C) 2017 Verizon.  All Rights Reserved.
 //: All Rights Reserved
@@ -20,6 +19,7 @@
 //: See the License for the specific language governing permissions and
 //: limitations under the License.
 //: ----------------------------------------------------------------------------
+
 package sflow
 
 import (
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package ipfix decodes IPFIX packets
		package ipfix
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package mirror replicates the IPFIX packets with spoofing feature to 3rd party collector
		package mirror
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package store ingest monitoring time series data points to different back-ends
		package store
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package netflow9 decodes netflow version v9 packets
		package netflow9
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package packet decodes layer two, three and four OSI model layers
		package packet
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package producer pushes decoded messages to message queues
		package producer
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package sflow decodes sFlow packets
		package sflow