version constants

version/parser.go

@@ -9,7 +9,7 @@ import (
 	"strings"
 )
 
-// Parser ...
+// Parser defines the interface of a version parser
 type Parser interface {
 	Parse(string) (Version, error)
 }
@@ -19,10 +19,10 @@ type parser struct {
 	versionSeparator string
 }
 
-// NewDefaultParser ...
+// NewDefaultParser returns a new parser with the default separators
 func NewDefaultParser() Parser { return NewParser(defaultAppSeparator, defaultVersionSeparator) }
 
-// NewParser ...
+// NewParser returns a new parser
 func NewParser(appSeparator string, versionSeparator string) Parser {
 	return &parser{
 		appSeparator:     appSeparator,

version/version.go

@@ -19,7 +19,7 @@ var (
 	errDifferentMinor = errors.New("different minor version")
 )
 
-// Version ...
+// Version defines what is needed to describe a version
 type Version interface {
 	fmt.Stringer
 
@@ -40,7 +40,7 @@ type version struct {
 	str   string
 }
 
-// NewDefaultVersion ...
+// NewDefaultVersion returns a new version with default separators
 func NewDefaultVersion(
 	app string,
 	major int,
@@ -57,7 +57,7 @@ func NewDefaultVersion(
 	)
 }
 
-// NewVersion ...
+// NewVersion returns a new version
 func NewVersion(
 	app string,
 	appSeparator string,