From 0e7d095a28b65f139f8dd208506df81b492c4c51 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=ABl=20Stemmer?= <stemmertech@gmail.com>
Date: Mon, 14 Mar 2022 23:01:04 +0000
Subject: [PATCH] gtr: add documentation to exported types and methods

---
 pkg/gtr/gtr.go | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/pkg/gtr/gtr.go b/pkg/gtr/gtr.go
index b97e4f9..3c071d3 100644
--- a/pkg/gtr/gtr.go
+++ b/pkg/gtr/gtr.go
@@ -8,10 +8,14 @@ import (
 	"time"
 )
 
+// Report contains the build, test and/or benchmark results of a collection of
+// packages.
 type Report struct {
 	Packages []Package
 }
 
+// IsSuccessful returns true if none of the packages in this report have build
+// or runtime errors and all tests passed without failures or were skipped.
 func (r *Report) IsSuccessful() bool {
 	for _, pkg := range r.Packages {
 		if pkg.BuildError.Name != "" || pkg.RunError.Name != "" {
@@ -26,6 +30,7 @@ func (r *Report) IsSuccessful() bool {
 	return true
 }
 
+// Package contains build, test and/or benchmark results for a single package.
 type Package struct {
 	Name       string
 	Duration   time.Duration
@@ -40,6 +45,9 @@ type Package struct {
 	RunError   Error
 }
 
+// SetProperty stores a key/value property in the current package. If a
+// property with the given key already exists, its old value will be
+// overwritten with the given value.
 func (p *Package) SetProperty(key, value string) {
 	if p.Properties == nil {
 		p.Properties = make(map[string]string)
@@ -47,6 +55,7 @@ func (p *Package) SetProperty(key, value string) {
 	p.Properties[key] = value
 }
 
+// Test contains the results of a single test.
 type Test struct {
 	Name     string
 	Duration time.Duration
@@ -55,6 +64,7 @@ type Test struct {
 	Output   []string
 }
 
+// Benchmark contains the results of a single benchmark.
 type Benchmark struct {
 	Name        string
 	Result      Result
@@ -66,6 +76,7 @@ type Benchmark struct {
 	AllocsPerOp int64
 }
 
+// Error contains details of a build or runtime error.
 type Error struct {
 	Name     string
 	Duration time.Duration