api documentation

pkg/semver/prerelease.go

@@ -9,6 +9,7 @@ import (
 )
 
 // PreReleaseVersion is similar to Version, but its string representation is reduced by removing trailing ".0"
+// All PreReleaseVersion instances have an associated `label`.
 type PreReleaseVersion struct {
 	version *Version
 	label   string
@@ -86,10 +87,12 @@ func parsePrereleaseVersion(versionStr string) (*PreReleaseVersion, error) {
 	return newPrereleaseVersion(label, major, minor, patch), nil
 }
 
+// Label returns the pre-release label
 func (v *PreReleaseVersion) Label() string {
 	return v.label
 }
 
+// Version returns the pre-release Version
 func (v *PreReleaseVersion) Version() Version {
 	return *v.version
 }

pkg/semver/semver.go

@@ -54,25 +54,29 @@ func versionPartInt(part VersionPart) int {
 	}
 }
 
+// SemanticVersion represents a parsed and validated semantic version
 type SemanticVersion struct {
 	rootVersion       *Version
 	preReleaseVersion *PreReleaseVersion
 	buildVersion      *BuildVersion
 }
 
+// RootVersion returns the root version part of the SemanticVersion
 func (v *SemanticVersion) RootVersion() Version {
 	return *v.rootVersion
 }
 
+// PreReleaseVersion returns the pre-release version part of the SemanticVersion
 func (v *SemanticVersion) PreReleaseVersion() PreReleaseVersion {
 	return *v.preReleaseVersion
 }
 
+// BuildVersion returns the BuildVersion part of the SemanticVersion
 func (v *SemanticVersion) BuildVersion() BuildVersion {
 	return *v.buildVersion
 }
 
-// String returns the rootVersion string
+// String returns the string representation of the SemanticVersion instance
 func (v *SemanticVersion) String() string {
 	if v == nil {
 		return ""
@@ -252,6 +256,7 @@ func ValidatePreReleaseLabelsString(preReleaseLabels string) bool {
 	return ValidatePreReleaseLabels(labels)
 }
 
+// SortVersions sorts a slice of SemanticVersion instances in descending order (latest to oldest)
 func SortVersions(versions []*SemanticVersion) {
 	sort.Slice(versions, func(i, j int) bool {
 		return versions[i].Compare(versions[j]) > 0