From 6164d9001d4b6d300e386db4ed295986c56f0635 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 10 May 2014 15:54:18 +0200
Subject: doc block updates

---
 inc/infoutils.php | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/inc/infoutils.php b/inc/infoutils.php
index 0992040d9..4faaee8ef 100644
--- a/inc/infoutils.php
+++ b/inc/infoutils.php
@@ -280,6 +280,15 @@ define('MSG_USERS_ONLY', 1);
 define('MSG_MANAGERS_ONLY',2);
 define('MSG_ADMINS_ONLY',4);
 
+/**
+ * Display a message to the user
+ *
+ * @param string $message
+ * @param int    $lvl   -1 = error, 0 = info, 1 = success, 2 = notify
+ * @param string $line  line number
+ * @param string $file  file number
+ * @param int    $allow who's allowed to see the message, see MSG_* constants
+ */
 function msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC){
     global $MSG, $MSG_shown;
     $errors[-1] = 'error';
@@ -309,6 +318,7 @@ function msg($message,$lvl=0,$line='',$file='',$allow=MSG_PUBLIC){
  *                         lvl   => int, level of the message (see msg() function)
  *                         allow => int, flag used to determine who is allowed to see the message
  *                                       see MSG_* constants
+ * @return bool
  */
 function info_msg_allowed($msg){
     global $INFO, $auth;
-- 
cgit v1.2.3