X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fstacker%2Fclass_Stackable.php;h=ac862f3ceb45696e71a6e778ce9dd17841f37668;hb=29fdfbe1fcc8f3644360c02e36007b21c05513a4;hp=f8ef7fe8ee3278a93a68837e13bc358a0ae18444;hpb=4b88c118b615335d06bd74e444173d21aef4406c;p=core.git

diff --git a/inc/classes/interfaces/stacker/class_Stackable.php b/inc/classes/interfaces/stacker/class_Stackable.php
index f8ef7fe8..ac862f3c 100644
--- a/inc/classes/interfaces/stacker/class_Stackable.php
+++ b/inc/classes/interfaces/stacker/class_Stackable.php
@@ -4,7 +4,7 @@
  *
  * @author		Roland Haeder <webmaster@ship-simu.org>
  * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
  * @license		GNU GPL 3.0 or any newer version
  * @link		http://www.ship-simu.org
  *
@@ -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
@@ -53,18 +53,18 @@ interface Stackable extends FrameworkInterface {
 	function getNamed ($stackerName);
 
 	/**
-	 * Checks wether the given stack is initialized (set in array $stackers)
+	 * Checks whether the given stack is initialized (set in array $stackers)
 	 *
 	 * @param	$stackerName	Name of the stack
-	 * @return	$isInitialized	Wether the stack is initialized
+	 * @return	$isInitialized	Whether the stack is initialized
 	 */
 	function isStackInitialized ($stackerName);
 
 	/**
-	 * Checks wether the given stack is empty
+	 * Checks whether the given stack is empty
 	 *
 	 * @param	$stackerName	Name of the stack
-	 * @return	$isEmpty			Wether the stack is empty
+	 * @return	$isEmpty			Whether the stack is empty
 	 * @throws	NoStackerException	If given stack is missing
 	 */
 	function isStackEmpty ($stackerName);