[Fusionforge-commits] r19045 - in trunk/src/common: forum include
Marc-Etienne VARGENAU
vargenau at fusionforge.org
Sun Feb 2 17:42:29 CET 2014
Author: vargenau
Date: 2014-02-02 17:42:29 +0100 (Sun, 02 Feb 2014)
New Revision: 19045
Modified:
trunk/src/common/forum/Forum.class.php
trunk/src/common/include/Permission.class.php
Log:
Update PHP Doc
Modified: trunk/src/common/forum/Forum.class.php
===================================================================
--- trunk/src/common/forum/Forum.class.php 2014-02-02 16:33:10 UTC (rev 19044)
+++ trunk/src/common/forum/Forum.class.php 2014-02-02 16:42:29 UTC (rev 19045)
@@ -430,7 +430,7 @@
/**
* setMonitor - Add the current user to the list of people monitoring the forum.
*
- * @param int user id of the user which will be set to monitor this forum. Defaults to 0, meaning the current logged in user will be used.
+ * @param int $u user id of the user which will be set to monitor this forum. Defaults to 0, meaning the current logged in user will be used.
* @return boolean success.
*/
function setMonitor($u = -1) {
@@ -543,9 +543,9 @@
/**
* update - use this function to update an entry in the database.
*
- * @param string The name of the forum.
- * @param string The description of the forum.
- * @param string The email address to send all new posts to.
+ * @param string $forum_name The name of the forum.
+ * @param string $description The description of the forum.
+ * @param string $send_all_posts_to The email address to send all new posts to.
* @return boolean success.
*/
function update($forum_name, $description, $send_all_posts_to = '') {
Modified: trunk/src/common/include/Permission.class.php
===================================================================
--- trunk/src/common/include/Permission.class.php 2014-02-02 16:33:10 UTC (rev 19044)
+++ trunk/src/common/include/Permission.class.php 2014-02-02 16:42:29 UTC (rev 19045)
@@ -33,11 +33,11 @@
* permission_get_object is useful so you can pool Permission objects/save database queries
* You should always use this instead of instantiating the object directly
*
- * @param $_Group object The Group in question
+ * @param object $_Group object The Group in question
* @return object a Permission or false on failure
*
*/
-function &permission_get_object(&$_Group, &$_User = NULL) {
+function &permission_get_object(&$_Group) {
//create a common set of Permission objects
//saves a little wear on the database
More information about the Fusionforge-commits
mailing list