Merge branch 'phpdoc' into piernov

1 files changed, 34 insertions, 0 deletions

diff --git a/inc/messages.inc b/inc/messages.inc
index 3a7d9b1..8583dc0 100644
--- a/inc/messages.inc
+++ b/inc/messages.inc
@@ -1,5 +1,15 @@
 <?php
+/**
+ * Server to client error/info messages list and helpers.
+ *
+ * @package inc\messages.inc
+ * @author     Alexandre Renoux
+ * @author     Pierre-Emmanuel Novac
+ */
 
+/**
+ * Messages list.
+ */
 $messages = array(
 	"shop_already_built" => "You have already built a shop.",
 	"gold_insufficient" => "You don't have enough gold.",
@@ -18,6 +28,14 @@ $messages = array(
 	"upload_success" => "Save file uploaded successfully: %s",
 );
 
+/**
+ * Sends a message to the client.
+ *
+ * @param string $type  message type, for example "info" or "error"
+ * @param string $msg   message content
+ * @param string $fmt   optional parameters to apply when formating message string
+ * @return void
+ */
 function sendMessage($type, $msg, $fmt = null) {
 	global $messages;
 	$text = $messages[$msg];
@@ -25,10 +43,26 @@ function sendMessage($type, $msg, $fmt = null) {
 	echo json_encode(array($type => $text));
 }
 
+/**
+ * Sends an error message to the client.
+ * Simple wrapper calling sendMessage with "error" as $type.
+ *
+ * @param string $msg   message content
+ * @param string $fmt   optional parameters to apply when formating message string
+ * @return void
+ */
 function sendError($msg, $fmt = null) {
 	sendMessage("error", $msg, $fmt);
 }
 
+/**
+ * Sends an info message to the client.
+ * Simple wrapper calling sendMessage with "info" as $type.
+ *
+ * @param string $msg   message content
+ * @param string $fmt   optional parameters to apply when formating message string
+ * @return void
+ */
 function sendInfo($msg, $fmt = null) {
 	sendMessage("info", $msg, $fmt);
 }