From e670b52a08b4c0af0a4e7723170d2b2bbb328307 Mon Sep 17 00:00:00 2001 From: Aaron Lindsay Date: Wed, 12 Apr 2017 21:39:54 -0400 Subject: [PATCH] common: Improve comments --- common.go | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/common.go b/common.go index 0ce8cdf..3940fed 100644 --- a/common.go +++ b/common.go @@ -7,16 +7,18 @@ import ( "github.com/aclindsa/go/src/encoding/xml" ) -// Represents an OFX message in a message set +// Message represents an OFX message in a message set. it is used to ease +// marshalling and unmarshalling. type Message interface { Name() string // The name of the OFX transaction wrapper element this represents - Valid() (bool, error) // Called before a Message is marshaled and after - // it's unmarshaled to ensure the request or response is valid - Type() messageType // The message set this message belongs to + Valid() (bool, error) // Called before a Message is marshaled and after it's unmarshaled to ensure the request or response is valid + Type() messageType // The message set this message belongs to } type messageType uint +// These constants are returned by Messages' Type() functions to determine +// which message set they belong to const ( // Requests SignonRq messageType = iota @@ -34,6 +36,7 @@ const ( PresDlvRq ProfRq ImageRq + // Responses SignonRs SignupRs