[Fusionforge-commits] r18392 - in trunk/src/common: docman forum include pm tracker

Marc-Etienne VARGENAU vargenau at fusionforge.org
Tue Nov 5 19:20:57 CET 2013


Author: vargenau
Date: 2013-11-05 19:20:57 +0100 (Tue, 05 Nov 2013)
New Revision: 18392

Modified:
   trunk/src/common/docman/Document.class.php
   trunk/src/common/forum/Forum.class.php
   trunk/src/common/include/Group.class.php
   trunk/src/common/pm/ProjectTask.class.php
   trunk/src/common/tracker/Artifact.class.php
Log:
Update PHP Doc

Modified: trunk/src/common/docman/Document.class.php
===================================================================
--- trunk/src/common/docman/Document.class.php	2013-11-05 17:56:17 UTC (rev 18391)
+++ trunk/src/common/docman/Document.class.php	2013-11-05 18:20:57 UTC (rev 18392)
@@ -1063,8 +1063,8 @@
 	/**
 	 * setValueinDB - private function to update columns in db
 	 *
-	 * @param	string	the column to update
-	 * @param	int	the value to store
+	 * @param	string	$column	the column to update
+	 * @param	int		$value	the value to store
 	 * @return	boolean	success or not
 	 * @access	private
 	 */

Modified: trunk/src/common/forum/Forum.class.php
===================================================================
--- trunk/src/common/forum/Forum.class.php	2013-11-05 17:56:17 UTC (rev 18391)
+++ trunk/src/common/forum/Forum.class.php	2013-11-05 18:20:57 UTC (rev 18392)
@@ -612,8 +612,8 @@
 	/**
 	 * delete - delete this forum and all its related data.
 	 *
-	 * @param	bool	I'm Sure.
-	 * @param	bool	I'm REALLY sure.
+	 * @param	bool	$sure		I'm Sure.
+	 * @param	bool	$really_sure	I'm REALLY sure.
 	 * @return	bool	true/false;
 	 */
 	function delete($sure, $really_sure) {

Modified: trunk/src/common/include/Group.class.php
===================================================================
--- trunk/src/common/include/Group.class.php	2013-11-05 17:56:17 UTC (rev 18391)
+++ trunk/src/common/include/Group.class.php	2013-11-05 18:20:57 UTC (rev 18392)
@@ -945,7 +945,7 @@
 	/**
 	 * setSCMBox - the hostname of the scm box where this project is located.
 	 *
-	 * @param	string	The name of the new SCM_BOX
+	 * @param	string	$scm_box	The name of the new SCM_BOX
 	 * @return bool
 	 */
 	function setSCMBox($scm_box) {
@@ -1123,7 +1123,7 @@
 	/**
 	 *	setUseMail - Set the mailing-list usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUseMail($booleanparam) {
@@ -1183,7 +1183,7 @@
 	/**
 	 *	setUseForum - Set the forum usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUseForum($booleanparam) {
@@ -1226,7 +1226,7 @@
 	/**
 	 *	setUseFRS - Set the FRS usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUseFRS($booleanparam) {
@@ -1260,7 +1260,7 @@
 	/**
 	 *	setUseTracker - Set the tracker usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUseTracker ($booleanparam) {
@@ -1307,7 +1307,7 @@
 	/**
 	 *	setUseDocman - Set the docman usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUseDocman($booleanparam) {
@@ -1404,7 +1404,7 @@
 	/**
 	 *	setUsePM - Set the PM usage
 	 *
-	 *	@param	boolean	enabled/disabled
+	 *	@param	boolean	$booleanparam	enabled/disabled
 	 * @return bool
 	 */
 	function setUsePM($booleanparam) {
@@ -1484,8 +1484,8 @@
 	/**
 	 * setPluginUse - enables/disables plugins for the group
 	 *
-	 * @param	string	name of the plugin
-	 * @param	boolean	the new state
+	 * @param	string	$pluginname	name of the plugin
+	 * @param	boolean	$val		the new state
 	 * @return	string	database result
 	 */
 	function setPluginUse($pluginname, $val=true) {
@@ -1947,12 +1947,12 @@
 	/**
 	 * addUser - controls adding a user to a group.
 	 *
-	 * @param	string	Unix name of the user to add OR integer user_id.
-	 * @param	int	The role_id this user should have.
+	 * @param	string	$user_identifier	Unix name of the user to add OR integer user_id.
+	 * @param	int		$role_id		The role_id this user should have.
 	 * @return	boolean	success.
 	 * @access	public
 	 */
-	function addUser($user_identifier,$role_id) {
+	function addUser($user_identifier, $role_id) {
 		global $SYS;
 		/*
 			Admins can add users to groups
@@ -2042,7 +2042,7 @@
 	 *
 	 * Users can remove themselves.
 	 *
-	 * @param	int	The ID of the user to remove.
+	 * @param	int	$user_id	The ID of the user to remove.
 	 * @return	boolean	success.
 	 */
 	function removeUser($user_id) {
@@ -2152,11 +2152,11 @@
 	/**
 	 * updateUser - controls updating a user's role in this group.
 	 *
-	 * @param	int	The ID of the user.
-	 * @param	int	The role_id to set this user to.
+	 * @param	int	$user_id	The ID of the user.
+	 * @param	int	$role_id	The role_id to set this user to.
 	 * @return	boolean	success.
 	 */
-	function updateUser($user_id,$role_id) {
+	function updateUser($user_id, $role_id) {
 
 		if (!forge_check_perm ('project_admin', $this->getID())) {
 			$this->setPermissionDeniedError();
@@ -2199,9 +2199,9 @@
 	/**
 	 * addHistory - Makes an audit trail entry for this project.
 	 *
-	 * @param	string	The name of the field.
-	 * @param	string	The Old Value for this $field_name.
-	 * @return database result handle.
+	 * @param	string	$field_name		The name of the field.
+	 * @param	string	$old_value		The Old Value for this $field_name.
+	 * @return 	resource				database result handle.
 	 * @access public
 	 */
 	function addHistory($field_name, $old_value) {
@@ -2272,7 +2272,7 @@
 	/**
 	 *	approve - Approve pending project.
 	 *
-	 *	@param	User	$user The User object who is doing the updating.
+	 *	@param	$user The User object who is doing the updating.
 	 *	@return bool
 	 *	@access public
 	 */
@@ -2602,9 +2602,9 @@
 	 * This function sends out a rejection message to a user who
 	 * registered a project.
 	 *
-	 * @param	int	The id of the response to use.
-	 * @param	string	The rejection message.
-	 * @return	boolean	completion status.
+	 * @param	int		$response_id	The id of the response to use.
+	 * @param	string	$message		The rejection message.
+	 * @return	bool	completion status.
 	 * @access	public
 	 */
 	function sendRejectionEmail($response_id, $message="zxcv") {
@@ -2622,8 +2622,8 @@
 			setup_gettext_for_user($admin);
 
 			$response = sprintf(_('Your project registration for %s has been denied.'), forge_get_config('forge_name')) . "\n\n"
-					. _('Project Full Name')._(': ').   $this->getPublicName() . "\n"
-					. _('Project Unix Name')._(': ').  $this->getUnixName() . "\n\n"
+					. _('Project Full Name')._(': '). $this->getPublicName() . "\n"
+					. _('Project Unix Name')._(': '). $this->getUnixName() . "\n\n"
 					. _('Reasons for negative decision')._(': ') . "\n\n";
 
 			// Check to see if they want to send a custom rejection response
@@ -2942,7 +2942,7 @@
 /**
  * group_getname() - get the group name
  *
- * @param	   int	 The group ID
+ * @param	   int	 $group_id	The group ID
  * @return string
  * @deprecated
  *
@@ -2959,7 +2959,7 @@
 /**
  * group_getunixname() - get the unixname for a group
  *
- * @param	   int	 The group ID
+ * @param	   int	 $group_id	The group ID
  * @return string
  * @deprecated
  *
@@ -2976,7 +2976,7 @@
 /**
  * group_get_result() - Get the group object result ID.
  *
- * @param	   int	 The group ID
+ * @param	   int	 $group_id	The group ID
  * @return int
  * @deprecated
  *

Modified: trunk/src/common/pm/ProjectTask.class.php
===================================================================
--- trunk/src/common/pm/ProjectTask.class.php	2013-11-05 17:56:17 UTC (rev 18391)
+++ trunk/src/common/pm/ProjectTask.class.php	2013-11-05 18:20:57 UTC (rev 18392)
@@ -430,7 +430,7 @@
 	/**
 	 *	getRelatedArtifacts - Return a result set of artifacts which are related to this task.
 	 *
-	 *	@return Database result set.
+	 *	@return resource	Database result set.
 	 */
 	function getRelatedArtifacts() {
 		if (!$this->relatedartifacts) {
@@ -579,7 +579,7 @@
 	 *	getOtherTasks - Return a result set of tasks in this subproject that do not equal
 	 *	the current task_id.
 	 *
-	 *	@return Database result set.
+	 *	@return resource	Database result set.
 	 */
 	function getOtherTasks () {
 		//
@@ -605,7 +605,7 @@
 	/**
 	 *  getHistory - returns a result set of audit trail for this ProjectTask.
 	 *
-	 *  @return database result set.
+	 *  @return resource	database result set.
 	 */
 	function getHistory() {
 		return db_query_params ('SELECT *
@@ -619,7 +619,7 @@
 	 *  getMessages - get the list of messages attached to this ProjectTask.
 	 *
 	 * @param bool $asc
-	 * @return database result set.
+	 * @return resource	database result set.
 	 */
 	function getMessages($asc=false) {
 		return db_query_params ('SELECT *
@@ -838,7 +838,7 @@
 				$this->dependon[db_result($res,$i,'is_dependent_on_task_id')] = db_result($res,$i,'link_type');
 			}
 		}
-		/* fix bug 319: if dependentlist is emtpy, set it to 100 (none) */
+		/* fix bug 319: if dependent list is empty, set it to 100 (none) */
 		if (!$this->dependon) {
 			$this->dependon[100]=PM_LINK_DEFAULT;
 		}

Modified: trunk/src/common/tracker/Artifact.class.php
===================================================================
--- trunk/src/common/tracker/Artifact.class.php	2013-11-05 17:56:17 UTC (rev 18391)
+++ trunk/src/common/tracker/Artifact.class.php	2013-11-05 18:20:57 UTC (rev 18392)
@@ -695,7 +695,7 @@
 	 *
 	 * @param    int    $msg_id id of the message.
 	 * @access public
-	 * @return database result set.
+	 * @return resource	database result set.
 	 */
 	function getMessage($msg_id) {
 		if (!$msg_id) {




More information about the Fusionforge-commits mailing list