docs for the dep function

1 files changed, 30 insertions, 0 deletions

diff --git a/lib/Bread/Board/Declare.pm b/lib/Bread/Board/Declare.pm
index 3f5dff5..0d1b6ea 100644
--- a/lib/Bread/Board/Declare.pm
+++ b/lib/Bread/Board/Declare.pm
@@ -26,6 +26,9 @@ use Bread::Board ();
   has tt => (
       is  => 'ro',
       isa => 'MyApp::View::TT',
+      dependencies => {
+          template_root => dep(value => './root/templates'),
+      },
   );
 
   has controller => (
@@ -146,6 +149,33 @@ sub init_meta {
     $package->$init_meta(%options);
 }
 
+=head1 EXPORTS
+
+=head2 dep
+
+  dependencies => {
+      foo => dep('foo'),
+      bar => dep(value => 'bar'),
+  }
+
+This is a helper function for specifying dependency lists. Passing a single
+argument will explicitly mark it as a dependency to be resolved by looking it
+up in the container. This isn't strictly necessary (the dependency
+specifications for L<Bread::Board> have a coercion which does this
+automatically), but being explicit can be easier to understand at times.
+
+This function can also take a hash of arguments. In that case, an anonymous
+service is created to satisfy the dependency. The hash is passed directly to
+the constructor for the appropriate service: if the C<value> parameter is
+passed, a L<Bread::Board::Literal> service will be created, if the C<block>
+parameter is passed, a L<Bread::Board::BlockInjection> service will be created,
+and if the C<class> parameter is passed, a
+L<Bread::Board::ConstructorInjection> service will be created. Note that these
+anonymous services cannot have dependencies themselves, nor can they be
+depended on by other services.
+
+=cut
+
 sub dep {
     if (@_ > 1) {
         my %opts = (