Add doc for registries

pkg/deploy/registry/deploy/doc.go

@@ -0,0 +1,3 @@
+// Package deploy provides Registry interface and its RESTStorage
+// implementation for storing Deployment api objects.
+package deploy

pkg/deploy/registry/deploy/registry.go

@@ -6,7 +6,7 @@ import (
   api "github.com/openshift/origin/pkg/deploy/api"
 )
 
-// Registry is an interface for things that know how to store Deployments
+// Registry is an interface for things that know how to store Deployments.
 type Registry interface {
   ListDeployments(selector labels.Selector) (*api.DeploymentList, error)
   GetDeployment(id string) (*api.Deployment, error)

pkg/deploy/registry/deploy/rest.go

@@ -21,13 +21,14 @@ type REST struct {
 	registry Registry
 }
 
+// NewREST creates a new REST backed by the given registry.
 func NewREST(registry Registry) apiserver.RESTStorage {
 	return &REST{
 		registry: registry,
 	}
 }
 
-// New creates a new Deployment for use with Create and Update
+// New creates a new Deployment for use with Create and Update.
 func (s *REST) New() runtime.Object {
 	return &deployapi.Deployment{}
 }

pkg/deploy/registry/deployconfig/doc.go

@@ -0,0 +1,3 @@
+// Package deployconfig provides Registry interface and its RESTStorage
+// implementation for storing DeploymentConfig api objects.
+package deployconfig

pkg/deploy/registry/deployconfig/registry.go

@@ -6,7 +6,7 @@ import (
 	api "github.com/openshift/origin/pkg/deploy/api"
 )
 
-// Registry is an interface for things that know how to store DeploymentConfigs
+// Registry is an interface for things that know how to store DeploymentConfigs.
 type Registry interface {
 	ListDeploymentConfigs(selector labels.Selector) (*api.DeploymentConfigList, error)
 	WatchDeploymentConfigs(resourceVersion uint64, filter func(repo *api.DeploymentConfig) bool) (watch.Interface, error)

pkg/deploy/registry/deployconfig/rest.go

@@ -17,13 +17,14 @@ type REST struct {
 	registry Registry
 }
 
+// NewREST creates a new REST backed by the given registry.
 func NewREST(registry Registry) apiserver.RESTStorage {
 	return &REST{
 		registry: registry,
 	}
 }
 
-// New creates a new DeploymentConfig for use with Create and Update
+// New creates a new DeploymentConfig for use with Create and Update.
 func (s *REST) New() runtime.Object {
 	return &deployapi.DeploymentConfig{}
 }

pkg/deploy/registry/etcd/doc.go

@@ -0,0 +1,3 @@
+// Package etcd provides etcd backend implementation for storing
+// Deployment and DeploymentConfig objects
+package etcd