popNamed() does also now return the current stacker's value.

[core.git] / inc / classes / interfaces / stacker / class_Stackable.php

diff --git a/inc/classes/interfaces/stacker/class_Stackable.php b/inc/classes/interfaces/stacker/class_Stackable.php
index f8ef7fe8ee3278a93a68837e13bc358a0ae18444..34b6cf18324e64e9876c54100a9d5abff408b60e 100644 (file)
--- a/inc/classes/interfaces/stacker/class_Stackable.php
+++ b/inc/classes/interfaces/stacker/class_Stackable.php
@@ -33,17 +33,17 @@ interface Stackable extends FrameworkInterface {
        function pushNamed ($stackerName, $value);
 
        /**
-        * 'Pops' a value from a named stacker
+        * 'Pops' a value from a named stacker and returns it's value
         *
         * @param       $stackerName    Name of the stacker
-        * @return      void
+        * @return      $value                  Value of the current stack entry
         * @throws      NoStackerException      If the named stacker was not found
         * @throws      EmptyStackerException   If the named stacker is empty
         */
        function popNamed ($stackerName);
 
        /**
-        * Get value from named stacker
+        * Get value from named stacker but don't "pop" it
         *
         * @param       $stackerName    Name of the stacker
         * @return      $value                  Value of last added value