From faefddcb8b3d3ac491331b702f8a8ac6fe58a894 Mon Sep 17 00:00:00 2001
From: piernov <piernov@piernov.org>
Date: Sun, 8 May 2016 20:14:40 +0200
Subject: First PHPDoc push, Inventory not complete

---
 inc/Monster.inc | 44 +++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 41 insertions(+), 3 deletions(-)

(limited to 'inc/Monster.inc')

diff --git a/inc/Monster.inc b/inc/Monster.inc
index c7063ec..4450b59 100644
--- a/inc/Monster.inc
+++ b/inc/Monster.inc
@@ -1,20 +1,58 @@
 <?php
-
+/**
+ * Represent an Item in the shop or in the Inventory.
+ *
+ * @author     Alexandre Renoux
+ * @author     Pierre-Emmanuel Novac
+ */
 class Monster {
+	/**
+	 * Name of the Monster.
+	 */
 	public $name = "";
+
+	/**
+	 * Monster's icon.
+	 */
 	public $icon = "";
-	public $desc = "";
+
+	/**
+	 * Monster's description.
+	 */
+	public $desc = ""; // TODO: unused
+
+	/**
+	 * HP of the Monster.
+	 */
 	public $hp = 1;
+
+	/**
+	 *  Exp given by this monster.
+	 */
 	public $xp = 0;
+
+	/**
+	 * Monster's level.
+	 */
 	public $level = 1;
 
+
+	/**
+	 * Monster's constructor
+	 *
+	 * @param string $name  Monster's name
+	 * @param int $level    Monster's level
+	 * @param int $hp       Monster's HP
+	 * @param int $xp       Exp given by the Monster
+	 * @param string $icon  Item's icon
+	 * @return void
+	 */
 	function __construct($name, $level, $hp, $xp, $icon) {
 		$this->name = $name;
 		$this->level = $level;
 		$this->hp = $hp;
 		$this->xp = $xp;
 		$this->icon = $icon;
-		
 	}
 }
 
-- 
cgit v1.2.3-54-g00ecf