From 365ea7e974e669547ee2c4a1b8f394149349c3ce Mon Sep 17 00:00:00 2001
From: Jesse Luehrs <doy@tozt.net>
Date: Mon, 21 Feb 2011 16:58:32 -0600
Subject: add docs

---
 lib/Bread/Board/Declare/BlockInjection.pm       |  4 ++++
 lib/Bread/Board/Declare/ConstructorInjection.pm |  4 ++++
 lib/Bread/Board/Declare/Literal.pm              |  4 ++++
 lib/Bread/Board/Declare/Meta/Role/Attribute.pm  | 21 +++++++++++++++++++++
 lib/Bread/Board/Declare/Meta/Role/Class.pm      |  5 +++++
 lib/Bread/Board/Declare/Role/Service.pm         | 10 ++++++++++
 6 files changed, 48 insertions(+)

(limited to 'lib/Bread/Board/Declare')

diff --git a/lib/Bread/Board/Declare/BlockInjection.pm b/lib/Bread/Board/Declare/BlockInjection.pm
index 4ea4f56..7ff4a9f 100644
--- a/lib/Bread/Board/Declare/BlockInjection.pm
+++ b/lib/Bread/Board/Declare/BlockInjection.pm
@@ -4,6 +4,10 @@ use Moose;
 
 =head1 DESCRIPTION
 
+This is a custom subclass of L<Bread::Board::BlockInjection> which does the
+L<Bread::Board::Declare::Role::Service> role. See those two modules for more
+details.
+
 =cut
 
 extends 'Bread::Board::BlockInjection';
diff --git a/lib/Bread/Board/Declare/ConstructorInjection.pm b/lib/Bread/Board/Declare/ConstructorInjection.pm
index 3d2a2c5..32b6f95 100644
--- a/lib/Bread/Board/Declare/ConstructorInjection.pm
+++ b/lib/Bread/Board/Declare/ConstructorInjection.pm
@@ -4,6 +4,10 @@ use Moose;
 
 =head1 DESCRIPTION
 
+This is a custom subclass of L<Bread::Board::ConstructorInjection> which does
+the L<Bread::Board::Declare::Role::Service> role. See those two modules for
+more details.
+
 =cut
 
 extends 'Bread::Board::ConstructorInjection';
diff --git a/lib/Bread/Board/Declare/Literal.pm b/lib/Bread/Board/Declare/Literal.pm
index c2269b1..a8574d2 100644
--- a/lib/Bread/Board/Declare/Literal.pm
+++ b/lib/Bread/Board/Declare/Literal.pm
@@ -4,6 +4,10 @@ use Moose;
 
 =head1 DESCRIPTION
 
+This is a custom subclass of L<Bread::Board::Literal> which does the
+L<Bread::Board::Declare::Role::Service> role. See those two modules for more
+details.
+
 =cut
 
 extends 'Bread::Board::Literal';
diff --git a/lib/Bread/Board/Declare/Meta/Role/Attribute.pm b/lib/Bread/Board/Declare/Meta/Role/Attribute.pm
index 82d90db..4ae6a94 100644
--- a/lib/Bread/Board/Declare/Meta/Role/Attribute.pm
+++ b/lib/Bread/Board/Declare/Meta/Role/Attribute.pm
@@ -12,10 +12,15 @@ use Bread::Board::Declare::Literal;
 
 =head1 DESCRIPTION
 
+This role adds functionality to the attribute metaclass for
+L<Bread::Board::Declare> objects.
+
 =cut
 
 =attr service
 
+Whether or not to create a service for this attribute. Defaults to true.
+
 =cut
 
 has service => (
@@ -26,6 +31,8 @@ has service => (
 
 =attr block
 
+The block to use when creating a L<Bread::Board::BlockInjection> service.
+
 =cut
 
 has block => (
@@ -36,6 +43,9 @@ has block => (
 
 =attr literal_value
 
+The value to use when creating a L<Bread::Board::Literal> service. Note that
+the parameter that should be passed to C<has> is C<value>.
+
 =cut
 
 # has_value is already a method
@@ -48,6 +58,9 @@ has literal_value => (
 
 =attr lifecycle
 
+The lifecycle to use when creating the service. See L<Bread::Board::Service>
+and L<Bread::Board::LifeCycle>.
+
 =cut
 
 has lifecycle => (
@@ -58,6 +71,9 @@ has lifecycle => (
 
 =attr dependencies
 
+The dependency specification to use when creating the service. See
+L<Bread::Board::Service::WithDependencies>.
+
 =cut
 
 has dependencies => (
@@ -69,6 +85,9 @@ has dependencies => (
 
 =attr constructor_name
 
+The constructor name to use when creating L<Bread::Board::ConstructorInjection>
+services. Defaults to C<new>.
+
 =cut
 
 has constructor_name => (
@@ -79,6 +98,8 @@ has constructor_name => (
 
 =attr associated_service
 
+The service object that is associated with this attribute.
+
 =cut
 
 has associated_service => (
diff --git a/lib/Bread/Board/Declare/Meta/Role/Class.pm b/lib/Bread/Board/Declare/Meta/Role/Class.pm
index 57a9db9..3ece152 100644
--- a/lib/Bread/Board/Declare/Meta/Role/Class.pm
+++ b/lib/Bread/Board/Declare/Meta/Role/Class.pm
@@ -7,10 +7,15 @@ use List::MoreUtils qw(any);
 
 =head1 DESCRIPTION
 
+This role adds functionality to the metaclass of L<Bread::Board::Declare>
+classes.
+
 =cut
 
 =method get_all_services
 
+Returns all of the services that are associated with attributes in this class.
+
 =cut
 
 sub get_all_services {
diff --git a/lib/Bread/Board/Declare/Role/Service.pm b/lib/Bread/Board/Declare/Role/Service.pm
index a428dfd..e0b36f9 100644
--- a/lib/Bread/Board/Declare/Role/Service.pm
+++ b/lib/Bread/Board/Declare/Role/Service.pm
@@ -4,10 +4,17 @@ use Moose::Role;
 
 =head1 DESCRIPTION
 
+This role modifies L<Bread::Board::Service> objects for use in
+L<Bread::Board::Declare>. It holds a reference to the attribute object that the
+service is associated with, and overrides the C<get> method to prefer to return
+the value in the attribute, if it exists.
+
 =cut
 
 =attr associated_attribute
 
+The attribute metaobject that this service is associated with.
+
 =cut
 
 has associated_attribute => (
@@ -32,6 +39,9 @@ around get => sub {
 
 =method parent_container
 
+Returns the Bread::Board::Declare container object that this service is
+contained in.
+
 =cut
 
 sub parent_container {
-- 
cgit v1.2.3-54-g00ecf