From 53bc5ac168cbd597922b42b32a005d3c7f3e8d5b Mon Sep 17 00:00:00 2001
From: bMancone <brice.mancone@prestashop.com>
Date: Mon, 24 Oct 2011 10:20:11 +0000
Subject: [PATCH] // Warehouse : updated comments..

git-svn-id: http://dev.prestashop.com/svn/v1/branches/1.5.x@9583 b9a71923-0436-4b27-9f14-aed3839534dd
---
 classes/stock/Warehouse.php | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/classes/stock/Warehouse.php b/classes/stock/Warehouse.php
index 394d5812d..d745f8870 100644
--- a/classes/stock/Warehouse.php
+++ b/classes/stock/Warehouse.php
@@ -167,7 +167,7 @@ class WarehouseCore extends ObjectModel
 	}
 
 	/**
-	 * Checks if a warehouse is empty - holds no stock
+	 * Checks if a warehouse is empty - i.e. holds no stock
 	 *
 	 * @return bool
 	 */
@@ -242,6 +242,14 @@ class WarehouseCore extends ObjectModel
 		return (Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($query));
 	}
 
+	/**
+	 * Gets the list of warehouses
+	 * It is possible via ignore_shop and id_shop to filter the list with shop id
+	 *
+	 * @param bool $ignore_shop false by default
+	 * @param int $id_shop null by default
+	 * @return array
+	 */
 	public static function getWarehouseList($ignore_shop = false, $id_shop = null)
 	{
 		if (!$ignore_shop)
@@ -256,4 +264,4 @@ class WarehouseCore extends ObjectModel
 
 		return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($query);
 	}
-}
+}
\ No newline at end of file