Adds license info to src file headers and formats comments.

Author: ackleymi

.golangci.yml

@@ -17,6 +17,7 @@ linters:
     - revive
     - unused
     - staticcheck
+    - godot
 
 linters-settings:
   gofmt:

LICENSE.txt renamed to LICENSE

@@ -1,6 +1,6 @@
 The QuickFIX Software License, Version 1.0
 
-Copyright (c) 2001-2010 quickfixengine.org  All rights
+Copyright (c) 2001- quickfixengine.org  All rights
 reserved.
 
 Redistribution and use in source and binary forms, with or without

accepter_test.go

@@ -1,3 +1,18 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
 import (

acceptor.go

@@ -1,3 +1,18 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
 import (

application.go

@@ -1,26 +1,41 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
 // Application interface should be implemented by FIX Applications.
 // This is the primary interface for processing messages from a FIX Session.
 type Application interface {
-	//OnCreate notification of a session begin created.
+	// OnCreate notification of a session begin created.
 	OnCreate(sessionID SessionID)
 
-	//OnLogon notification of a session successfully logging on.
+	// OnLogon notification of a session successfully logging on.
 	OnLogon(sessionID SessionID)
 
-	//OnLogout notification of a session logging off or disconnecting.
+	// OnLogout notification of a session logging off or disconnecting.
 	OnLogout(sessionID SessionID)
 
-	//ToAdmin notification of admin message being sent to target.
+	// ToAdmin notification of admin message being sent to target.
 	ToAdmin(message *Message, sessionID SessionID)
 
-	//ToApp notification of app message being sent to target.
+	// ToApp notification of app message being sent to target.
 	ToApp(message *Message, sessionID SessionID) error
 
-	//FromAdmin notification of admin message being received from target.
+	// FromAdmin notification of admin message being received from target.
 	FromAdmin(message *Message, sessionID SessionID) MessageRejectError
 
-	//FromApp notification of app message being received from target.
+	// FromApp notification of app message being received from target.
 	FromApp(message *Message, sessionID SessionID) MessageRejectError
 }

begin_string.go

@@ -1,6 +1,21 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
-// FIX BeginString string values
+// FIX BeginString string values.
 const (
 	BeginStringFIX40  = "FIX.4.0"
 	BeginStringFIX41  = "FIX.4.1"

cmd/generate-fix/generate-fix.go

@@ -164,7 +164,7 @@ func main() {
 		}
 
 		switch pkg {
-		//uses fixt11 header/trailer
+		// Uses fixt11 header/trailer.
 		case "fix50", "fix50sp1", "fix50sp2":
 		default:
 			waitGroup.Add(1)

cmd/generate-fix/internal/globals.go

@@ -14,7 +14,7 @@ var (
 	GlobalFieldTypes       []*datadictionary.FieldType
 )
 
-//sort fieldtypes by name
+// Sort fieldtypes by name.
 type byFieldName []*datadictionary.FieldType
 
 func (n byFieldName) Len() int           { return len(n) }
@@ -36,14 +36,14 @@ func BuildGlobalFieldTypes(specs []*datadictionary.DataDictionary) {
 	for _, spec := range specs {
 		for _, field := range spec.FieldTypeByTag {
 			if oldField, ok := globalFieldTypesLookup[field.Name()]; ok {
-				//merge old enums with new
+				// Merge old enums with new.
 				if len(oldField.Enums) > 0 && field.Enums == nil {
 					field.Enums = make(map[string]datadictionary.Enum)
 				}
 
 				for enumVal, enum := range oldField.Enums {
 					if _, ok := field.Enums[enumVal]; !ok {
-						//Verify an existing enum doesn't have the same description. Keep newer enum
+						// Verify an existing enum doesn't have the same description. Keep newer enum.
 						okToKeepEnum := true
 						for _, newEnum := range field.Enums {
 							if newEnum.Description == enum.Description {

cmd/generate-fix/internal/template_helpers.go

@@ -306,7 +306,7 @@ func routerBeginString(spec *datadictionary.DataDictionary) (routerBeginString s
 		routerBeginString = "FIXT.1.1"
 	case spec.Major != 5 && spec.ServicePack == 0:
 		routerBeginString = fmt.Sprintf("FIX.%v.%v", spec.Major, spec.Minor)
-		//ApplVerID enums
+		// ApplVerID enums.
 	case spec.Major == 2:
 		routerBeginString = "0"
 	case spec.Major == 3:

config/configuration.go

@@ -1,8 +1,8 @@
 package config
 
-//NOTE: Additions to this file should be made to both config/doc.go and http://www.quickfixgo.org/docs/
+// NOTE: Additions to this file should be made to both config/doc.go and http://www.quickfixgo.org/docs/
 
-// Const configuration settings
+// Const configuration settings.
 const (
 	BeginString                  string = "BeginString"
 	SenderCompID                 string = "SenderCompID"

connection.go

@@ -1,3 +1,18 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
 import "io"

connection_internal_test.go

@@ -1,3 +1,18 @@
+// Copyright (c) quickfixengine.org  All rights reserved.
+//
+// This file may be distributed under the terms of the quickfixengine.org
+// license as defined by quickfixengine.org and appearing in the file
+// LICENSE included in the packaging of this file.
+//
+// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING
+// THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A
+// PARTICULAR PURPOSE.
+//
+// See http://www.quickfixengine.org/LICENSE for licensing information.
+//
+// Contact [email protected] if any conditions of this licensing
+// are not clear to you.
+
 package quickfix
 
 import (

datadictionary/datadictionary.go

@@ -23,13 +23,13 @@ type DataDictionary struct {
 	Trailer         *MessageDef
 }
 
-// MessagePart can represent a Field, Repeating Group, or Component
+// MessagePart can represent a Field, Repeating Group, or Component.
 type MessagePart interface {
 	Name() string
 	Required() bool
 }
 
-// messagePartWithFields is a MessagePart with multiple Fields
+// messagePartWithFields is a MessagePart with multiple Fields.
 type messagePartWithFields interface {
 	MessagePart
 	Fields() []*FieldDef
@@ -45,7 +45,7 @@ type ComponentType struct {
 	requiredParts  []MessagePart
 }
 
-// NewComponentType returns an initialized component type
+// NewComponentType returns an initialized component type.
 func NewComponentType(name string, parts []MessagePart) *ComponentType {
 	comp := ComponentType{
 		name:  name,
@@ -77,20 +77,20 @@ func NewComponentType(name string, parts []MessagePart) *ComponentType {
 	return &comp
 }
 
-// Name returns the name of this component type
+// Name returns the name of this component type.
 func (c ComponentType) Name() string { return c.name }
 
 // Fields returns all fields contained in this component. Includes fields
-// encapsulated in components of this component
+// encapsulated in components of this component.
 func (c ComponentType) Fields() []*FieldDef { return c.fields }
 
-// RequiredFields returns those fields that are required for this component
+// RequiredFields returns those fields that are required for this component.
 func (c ComponentType) RequiredFields() []*FieldDef { return c.requiredFields }
 
-// RequiredParts returns those parts that are required for this component
+// RequiredParts returns those parts that are required for this component.
 func (c ComponentType) RequiredParts() []MessagePart { return c.requiredParts }
 
-// Parts returns all parts in declaration order contained in this component
+// Parts returns all parts in declaration order contained in this component.
 func (c ComponentType) Parts() []MessagePart { return c.parts }
 
 // TagSet is set for tags.
@@ -101,13 +101,13 @@ func (t TagSet) Add(tag int) {
 	t[tag] = struct{}{}
 }
 
-// Component is a Component as it appears in a given MessageDef
+// Component is a Component as it appears in a given MessageDef.
 type Component struct {
 	*ComponentType
 	required bool
 }
 
-// NewComponent returns an initialized Component instance
+// NewComponent returns an initialized Component instance.
 func NewComponent(ct *ComponentType, required bool) *Component {
 	return &Component{
 		ComponentType: ct,
@@ -116,10 +116,10 @@ func NewComponent(ct *ComponentType, required bool) *Component {
 }
 
 // Required returns true if this component is required for the containing
-// MessageDef
+// MessageDef.
 func (c Component) Required() bool { return c.required }
 
-// Field models a field or repeating group in a message
+// Field models a field or repeating group in a message.
 type Field interface {
 	Tag() int
 }
@@ -135,15 +135,15 @@ type FieldDef struct {
 	requiredFields []*FieldDef
 }
 
-// NewFieldDef returns an initialized FieldDef
+// NewFieldDef returns an initialized FieldDef.
 func NewFieldDef(fieldType *FieldType, required bool) *FieldDef {
 	return &FieldDef{
 		FieldType: fieldType,
 		required:  required,
 	}
 }
 
-// NewGroupFieldDef returns an initialized FieldDef for a repeating group
+// NewGroupFieldDef returns an initialized FieldDef for a repeating group.
 func NewGroupFieldDef(fieldType *FieldType, required bool, parts []MessagePart) *FieldDef {
 	field := FieldDef{
 		FieldType: fieldType,
@@ -179,7 +179,7 @@ func NewGroupFieldDef(fieldType *FieldType, required bool, parts []MessagePart)
 }
 
 // Required returns true if this FieldDef is required for the containing
-// MessageDef
+// MessageDef.
 func (f FieldDef) Required() bool { return f.required }
 
 // IsGroup is true if the field is a repeating group.
@@ -188,11 +188,11 @@ func (f FieldDef) IsGroup() bool {
 }
 
 // RequiredParts returns those parts that are required for this FieldDef. IsGroup
-// must return true
+// must return true.
 func (f FieldDef) RequiredParts() []MessagePart { return f.requiredParts }
 
 // RequiredFields returns those fields that are required for this FieldDef. IsGroup
-// must return true
+// must return true.
 func (f FieldDef) RequiredFields() []*FieldDef { return f.requiredFields }
 
 func (f FieldDef) childTags() []int {
@@ -214,7 +214,7 @@ type FieldType struct {
 	Enums map[string]Enum
 }
 
-// NewFieldType returns a pointer to an initialized FieldType
+// NewFieldType returns a pointer to an initialized FieldType.
 func NewFieldType(name string, tag int, fixType string) *FieldType {
 	return &FieldType{
 		name: name,
@@ -223,10 +223,10 @@ func NewFieldType(name string, tag int, fixType string) *FieldType {
 	}
 }
 
-// Name returns the name for this FieldType
+// Name returns the name for this FieldType.
 func (f FieldType) Name() string { return f.name }
 
-// Tag returns the tag for this fieldType
+// Tag returns the tag for this fieldType.
 func (f FieldType) Tag() int { return f.tag }
 
 // Enum is a container for value and description.
@@ -240,19 +240,18 @@ type MessageDef struct {
 	Name    string
 	MsgType string
 	Fields  map[int]*FieldDef
-	//Parts are the MessageParts of contained in this MessageDef in declaration
-	//order
+	// Parts are the MessageParts of contained in this MessageDef in declaration order.
 	Parts         []MessagePart
 	requiredParts []MessagePart
 
 	RequiredTags TagSet
 	Tags         TagSet
 }
 
-// RequiredParts returns those parts that are required for this Message
+// RequiredParts returns those parts that are required for this Message.
 func (m MessageDef) RequiredParts() []MessagePart { return m.requiredParts }
 
-// NewMessageDef returns a pointer to an initialized MessageDef
+// NewMessageDef returns a pointer to an initialized MessageDef.
 func NewMessageDef(name, msgType string, parts []MessagePart) *MessageDef {
 	msg := MessageDef{
 		Name:         name,
@@ -283,8 +282,8 @@ func NewMessageDef(name, msgType string, parts []MessagePart) *MessageDef {
 		switch pType := part.(type) {
 		case messagePartWithFields:
 			for _, f := range pType.Fields() {
-				//field if required in component is required in message only if
-				//component is required
+				// Field if required in component is required in message only if
+				// component is required.
 				processField(f, pType.Required())
 			}