phpdoc

[m6w6/pq-gateway] / lib / pq / Mapper / RefPropertyInterface.php

diff --git a/lib/pq/Mapper/RefPropertyInterface.php b/lib/pq/Mapper/RefPropertyInterface.php
index 5fae13ae20bf9613459e67f60ff2f77ad9beb353..f9b1ee5c3f03f76b766343b8d4f099cbfc78afe9 100644 (file)
--- a/lib/pq/Mapper/RefPropertyInterface.php
+++ b/lib/pq/Mapper/RefPropertyInterface.php
@@ -5,22 +5,28 @@ namespace pq\Mapper;
 interface RefPropertyInterface extends PropertyInterface
 {
        /**
+        * Define the referred class
         * @param string $class
+        * @return RefPropertyInterface
         */
        function to($class);
 
        /**
+        * Check whether this mapping refers to $class
         * @param string $class
         * @return bool
         */
        function references($class);
 
        /**
+        * Define the foreign key name as defined by pq\Gateway\Table\Reference
         * @param string $ref
+        * @return RefPropertyInterface
         */
        function by($ref);
 
        /**
+        * Check whether this mapping referes to a foreign key
         * @param string $ref
         * @return bool
         */