fix a number of exported comments

Signed-off-by: killianmuldoon <[email protected]>

cmd/clusterctl/client/client.go

@@ -75,7 +75,7 @@ type Client interface {
 	// DescribeCluster returns the object tree representing the status of a Cluster API cluster.
 	DescribeCluster(options DescribeClusterOptions) (*tree.ObjectTree, error)
 
-	// Interface for alpha features in clusterctl
+	// AlphaClient is an Interface for alpha features in clusterctl
 	AlphaClient
 }
 

cmd/clusterctl/client/config/providers_client.go

@@ -26,8 +26,9 @@ import (
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 )
 
-// Core providers.
+// core providers.
 const (
+	// ClusterAPIProviderName is the name for the core provider.
 	ClusterAPIProviderName = "cluster-api"
 )
 
@@ -66,6 +67,7 @@ const (
 
 // Other.
 const (
+	// ProvidersConfigKey is a constant for finding provider configurations with the ProvidersClient.
 	ProvidersConfigKey = "providers"
 )
 

cmd/clusterctl/client/init.go

@@ -144,7 +144,7 @@ func (c *clusterctlClient) Init(options InitOptions) ([]Components, error) {
 	return aliasComponents, nil
 }
 
-// Init returns the list of images required for init.
+// InitImages returns the list of images required for init.
 func (c *clusterctlClient) InitImages(options InitOptions) ([]string, error) {
 	// gets access to the management cluster
 	clusterClient, err := c.clusterClientFactory(ClusterClientFactoryInput{Kubeconfig: options.Kubeconfig})

cmd/clusterctl/client/repository/client.go

@@ -31,7 +31,7 @@ import (
 type Client interface {
 	config.Provider
 
-	// GetVersion return the list of versions that are available in a provider repository
+	// GetVersions return the list of versions that are available in a provider repository
 	GetVersions() ([]string, error)
 
 	// Components provide access to YAML file for creating provider components.
@@ -151,7 +151,7 @@ type Repository interface {
 	// GetFile return a file for a given provider version.
 	GetFile(version string, path string) ([]byte, error)
 
-	// GetVersion return the list of versions that are available in a provider repository
+	// GetVersions return the list of versions that are available in a provider repository
 	GetVersions() ([]string, error)
 }
 

cmd/clusterctl/client/repository/components.go

@@ -57,7 +57,7 @@ const (
 // 3. Ensure all the ClusterRoleBinding which are referencing namespaced objects have the name prefixed with the namespace name
 // 4. Adds labels to all the components in order to allow easy identification of the provider objects.
 type Components interface {
-	// configuration of the provider the provider components belongs to.
+	// Provider holds configuration of the provider the provider components belong to.
 	config.Provider
 
 	// Version of the provider.

cmd/clusterctl/client/repository/components_client.go

@@ -51,7 +51,7 @@ func newComponentsClient(provider config.Provider, repository Repository, config
 	}
 }
 
-// Get returns the components from a repository.
+// Raw returns the components from a repository.
 func (f *componentsClient) Raw(options ComponentsOptions) ([]byte, error) {
 	return f.getRawBytes(&options)
 }

cmd/clusterctl/client/repository/repository_github.go

@@ -80,7 +80,7 @@ func (g *gitHubRepository) DefaultVersion() string {
 	return g.defaultVersion
 }
 
-// GetVersion returns the list of versions that are available in a provider repository.
+// GetVersions returns the list of versions that are available in a provider repository.
 func (g *gitHubRepository) GetVersions() ([]string, error) {
 	versions, err := g.getVersions()
 	if err != nil {

cmd/clusterctl/client/yamlprocessor/processor.go

@@ -32,7 +32,7 @@ type Processor interface {
 	// list of variables that the template uses.
 	GetVariables([]byte) ([]string, error)
 
-	// GetVariables parses the template blob of bytes and provides a
+	// GetVariableMap parses the template blob of bytes and provides a
 	// map of variables that the template uses with their default values.
 	GetVariableMap([]byte) (map[string]*string, error)