[Fusionforge-commits] r18345 - in trunk/src/common: docman forum import include valid
Marc-Etienne VARGENAU
vargenau at fusionforge.org
Wed Oct 30 14:42:40 CET 2013
Author: vargenau
Date: 2013-10-30 14:42:40 +0100 (Wed, 30 Oct 2013)
New Revision: 18345
Modified:
trunk/src/common/docman/DocumentManager.class.php
trunk/src/common/forum/Forum.class.php
trunk/src/common/import/import_trackers.php
trunk/src/common/include/PluginManager.class.php
trunk/src/common/include/account.php
trunk/src/common/valid/ValidFactory.class.php
Log:
Update PHP Doc
Modified: trunk/src/common/docman/DocumentManager.class.php
===================================================================
--- trunk/src/common/docman/DocumentManager.class.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/docman/DocumentManager.class.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -144,9 +144,9 @@
/**
* getTree - display recursively the content of the doc_group. Only doc_groups within doc_groups.
*
- * @param integer the selected directory
- * @param string the type of link in the menu
- * @param integer the doc_group to start: default 0
+ * @param int $selecteddir the selected directory
+ * @param string $linkmenu the type of link in the menu
+ * @param int $docGroupId the doc_group to start: default 0
*/
function getTree($selecteddir, $linkmenu, $docGroupId = 0) {
global $g; // the master group of all the groups .... anyway.
Modified: trunk/src/common/forum/Forum.class.php
===================================================================
--- trunk/src/common/forum/Forum.class.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/forum/Forum.class.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -161,11 +161,11 @@
/**
* create - use this function to create a new 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 int Pass (1) if a welcome message should be created (0) for no welcome message.
- * @return boolean success.
+ * @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.
+ * @param int $create_default_message Pass (1) if a welcome message should be created (0) for no welcome message.
+ * @return bool success.
*/
function create($forum_name, $description, $send_all_posts_to = '', $create_default_message = 1) {
if (!$this->is_news && strlen(trim($forum_name)) < 3) {
Modified: trunk/src/common/import/import_trackers.php
===================================================================
--- trunk/src/common/import/import_trackers.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/import/import_trackers.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -141,7 +141,7 @@
/**
* deleteTrackers - Delete all existing default trackers from a projet
- * @param Group A Group object
+ * @param Group $group A Group object
*/
function deleteTrackers($group){
$res = db_query_params ('SELECT group_artifact_id FROM artifact_group_list
@@ -157,8 +157,8 @@
/**
* addComments - Add followup comments to an Artifact Object
- * @param Artifact the artifact object where history should be added
- * @param array the artifact's data in json format (an array)
+ * @param Artifact $artifact the artifact object where history should be added
+ * @param array $jsonArtifact the artifact's data in json format (an array)
*/
function addComments($artifact, $jsonArtifact){
foreach($jsonArtifact['comments'] as $c){
@@ -171,8 +171,8 @@
/**
* addHistory - Add history of changes to an Artifact Object
- * @param Artifact the artifact object where history should be added
- * @param array the artifact's data in json format (an array)
+ * @param Artifact $artifact the artifact object where history should be added
+ * @param array $jsonArtifact the artifact's data in json format (an array)
*/
function addHistory($artifact, $jsonArtifact){
foreach($jsonArtifact['history'] as $h){
Modified: trunk/src/common/include/PluginManager.class.php
===================================================================
--- trunk/src/common/include/PluginManager.class.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/include/PluginManager.class.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -85,8 +85,8 @@
/**
* PluginIsInstalled() - is a plugin installed?
*
- * @param string name of plugin
- * @return boolean true if installed
+ * @param string $pluginname name of plugin
+ * @return bool true if installed
*/
function PluginIsInstalled($pluginname) {
$plugins_data = $this->getPlugins();
Modified: trunk/src/common/include/account.php
===================================================================
--- trunk/src/common/include/account.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/include/account.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -149,7 +149,7 @@
/**
* account_gensalt() - A random salt generator
*
- * @returns The random salt string
+ * @returns string The random salt string
*
*/
function account_gensalt(){
Modified: trunk/src/common/valid/ValidFactory.class.php
===================================================================
--- trunk/src/common/valid/ValidFactory.class.php 2013-10-30 08:50:08 UTC (rev 18344)
+++ trunk/src/common/valid/ValidFactory.class.php 2013-10-30 13:42:40 UTC (rev 18345)
@@ -146,8 +146,8 @@
/**
* Is uploaded file empty or not.
*
- * @param Array One entry of $_FILES
- * @return bool
+ * @param array $file One entry of $_FILES
+ * @return bool
*/
function isEmptyValue($file) {
if(!is_array($file)) {
@@ -162,8 +162,8 @@
/**
* Check rules on given file.
*
- * @param $files Array $_FILES superarray.
- * @param string $index
+ * @param array $files $_FILES superarray.
+ * @param string $index
* @return bool
*/
function validate($files, $index='') {
More information about the Fusionforge-commits
mailing list