First PHPDoc push, Inventory not complete

1 files changed, 29 insertions, 0 deletions

diff --git a/inc/guild.inc b/inc/guild.inc
index c0e8264..f348348 100644
--- a/inc/guild.inc
+++ b/inc/guild.inc
@@ -1,8 +1,26 @@
 <?php
+/**
+ * Manages miners guild.
+ *
+ * @author     Alexandre Renoux
+ * @author     Pierre-Emmanuel Novac
+ */
 
+/**
+ * Amount of gold required to build the miners guild.
+ */
 define("GUILD_COST",10);
+/**
+ * Amount of gold required to hire a miner.
+ */
 define("MINER_COST",5);
 
+/**
+ * Create the miners guild in the session.
+ * Debits GUILD_COST from the player's gold.
+ *
+ * @return void
+ */
 function createGuild(){
 	if(!empty($_SESSION["guild"])) {
 		sendError("guild_already_built");
@@ -13,6 +31,12 @@ function createGuild(){
 	}
 }
 
+/**
+ * Hire one miner.
+ * Debits MINER_COST from the player's gold.
+ *
+ * @return void
+ */
 function hireMiner(){
 	if(!isset($_SESSION["guild"])){
 		sendError("guild_not_yet_created");
@@ -23,6 +47,11 @@ function hireMiner(){
 	}
 }
 
+/**
+ * Returns the number of miners currently in the guild.
+ *
+ * @return int  number of miners in the guild
+ */
 function sendMiners(){
 	return $_SESSION["mine"]["miners"];
 }