[Fusionforge-commits] r18595 - in trunk/src/common: forum frs include pm

Marc-Etienne VARGENAU vargenau at fusionforge.org
Thu Dec 5 21:15:31 CET 2013


Author: vargenau
Date: 2013-12-05 21:15:31 +0100 (Thu, 05 Dec 2013)
New Revision: 18595

Modified:
   trunk/src/common/forum/AttachManager.class.php
   trunk/src/common/frs/FRSPackage.class.php
   trunk/src/common/frs/FRSRelease.class.php
   trunk/src/common/include/session.php
   trunk/src/common/pm/ProjectGroup.class.php
   trunk/src/common/pm/ProjectGroupFactory.class.php
Log:
Update PHP Doc

Modified: trunk/src/common/forum/AttachManager.class.php
===================================================================
--- trunk/src/common/forum/AttachManager.class.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/forum/AttachManager.class.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -82,7 +82,7 @@
 	* Function PrintHelperFunctions
 	*
 	*
-	* @return 	returns the javascript helper functions
+	* @return 	string	returns the javascript helper functions
 	*/
 
 	function PrintHelperFunctions() {

Modified: trunk/src/common/frs/FRSPackage.class.php
===================================================================
--- trunk/src/common/frs/FRSPackage.class.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/frs/FRSPackage.class.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -361,9 +361,9 @@
 	/**
 	 *	update - update an FRSPackage in the database.
 	 *
-	 *	@param	string	The name of this package.
-	 *	@param	int	The status_id of this package from frs_status table.
-	 *	@param	int	public or private : 1 or 0
+	 *	@param	string	$name		The name of this package.
+	 *	@param	int		$status		The status_id of this package from frs_status table.
+	 *	@param	int		$is_public	public or private : 1 or 0
 	 *	@return	boolean success.
 	 */
 	function update($name, $status, $is_public = 1) {

Modified: trunk/src/common/frs/FRSRelease.class.php
===================================================================
--- trunk/src/common/frs/FRSRelease.class.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/frs/FRSRelease.class.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -345,8 +345,8 @@
 	/**
 	 *  delete - delete this release 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/session.php
===================================================================
--- trunk/src/common/include/session.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/include/session.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -44,7 +44,7 @@
 /**
  *	session_build_session_token() - Construct session token for the user
  *
- *	@param		int		User_id of the logged in user
+ *	@param		int		$user_id	User_id of the logged in user
  *	@return string token value
  */
 function session_build_session_token($user_id) {
@@ -82,8 +82,8 @@
  *
  *	This hash can be used as a key to identify session, e.g. in DB.
  *
- *	@param		string	Value of the session token
- *	@return hash
+ *	@param		string	$session_token	Value of the session token
+ *	@return string	hash
  */
 function session_get_hash_from_token($session_token) {
 	return session_get_session_cookie_hash($session_token);
@@ -100,7 +100,7 @@
 /**
  *	session_check_session_token() - Check that session token passed from user is ok
  *
- *	@param		string	Value of the session token
+ *	@param		string	$session_token	Value of the session token
  *	@return user_id if token is ok, false otherwise
  */
 function session_check_session_token($session_token) {

Modified: trunk/src/common/pm/ProjectGroup.class.php
===================================================================
--- trunk/src/common/pm/ProjectGroup.class.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/pm/ProjectGroup.class.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -353,8 +353,8 @@
 	/**
 	 * delete - delete this subproject 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/pm/ProjectGroupFactory.class.php
===================================================================
--- trunk/src/common/pm/ProjectGroupFactory.class.php	2013-12-05 20:14:12 UTC (rev 18594)
+++ trunk/src/common/pm/ProjectGroupFactory.class.php	2013-12-05 20:15:31 UTC (rev 18595)
@@ -91,7 +91,7 @@
 	/**
 	 *	getProjectGroups - get an array of ProjectGroup objects.
 	 *
-	 *	@return	ProjectGroups[]	The array of ProjectGroups.
+	 *	@return	array	ProjectGroups[]	The array of ProjectGroups.
 	 */
 	function getProjectGroups() {
 		if ($this->projectGroups) {




More information about the Fusionforge-commits mailing list