Phpdoc.
authorGunnar Wrobel <p@rdus.de>
Fri, 2 Oct 2009 13:40:09 +0000 (15:40 +0200)
committerGunnar Wrobel <p@rdus.de>
Fri, 2 Oct 2009 13:40:09 +0000 (15:40 +0200)
framework/Injector/lib/Horde/Injector/Binder.php

index fafa479..764c129 100644 (file)
@@ -1,12 +1,44 @@
 <?php
+/**
+ * Binder interface definition.
+ *
+ * PHP version 5
+ *
+ * @category Horde
+ * @package  Injector
+ * @author   Bob Mckee <bmckee@bywires.com>
+ * @author   James Pepin <james@jamespepin.com>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ * @link     http://pear.horde.org/index.php?package=Injector
+ */
+
+/**
+ * Describes a binding class that is able to create concrete object instances.
+ *
+ * @category Horde
+ * @package  Injector
+ * @author   Bob Mckee <bmckee@bywires.com>
+ * @author   James Pepin <james@jamespepin.com>
+ * @license  http://opensource.org/licenses/bsd-license.php BSD
+ * @link     http://pear.horde.org/index.php?package=Injector
+ */
 interface Horde_Injector_Binder
 {
+    /**
+     * Create an instance.
+     *
+     * @param Horde_Injector $injector The injector should provide all required
+     *                                 dependencies for creating the instance.
+     *
+     * @return mixed The concrete instance.
+     */
     public function create(Horde_Injector $injector);
 
     /**
-     * determine if one binder equals another binder
+     * Determine if one binder equals another binder
      *
      * @param Horde_Injector_Binder $binder The binder to compare against $this
+     *
      * @return bool true if they are equal, or false if they are not equal
      */
     public function equals(Horde_Injector_Binder $binder);