fix up package docs

Author: mmlb

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 (

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 (

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 (

ipfix/doc.go

@@ -0,0 +1,2 @@
+// Package ipfix decodes IPFIX packets
+package ipfix

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 (

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 (

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 (

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 (

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 (

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 (

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

mirror/doc.go

@@ -0,0 +1,2 @@
+// Package mirror replicates the IPFIX packets with spoofing feature to 3rd party collector
+package mirror

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 (

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 (

monitor/monitor.go

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

monitor/store/doc.go

@@ -0,0 +1,2 @@
+// Package store ingest monitoring time series data points to different back-ends
+package store

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 (

netflow/v9/decoder.go

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

netflow/v9/doc.go

@@ -0,0 +1,2 @@
+// Package netflow9 decodes netflow version v9 packets
+package netflow9

netflow/v9/memcache.go

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

packet/doc.go

@@ -0,0 +1,2 @@
+// Package packet decodes layer two, three and four OSI model layers
+package packet

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 (

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"

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"

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 (

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"

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"

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"

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"

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"

producer/doc.go

@@ -0,0 +1,2 @@
+// Package producer pushes decoded messages to message queues
+package producer

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 (

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 (

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 (

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 (

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 (

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 (

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 (

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 (

sflow/doc.go

@@ -0,0 +1,2 @@
+// Package sflow decodes sFlow packets
+package sflow

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 (