gctools-outilsgc / gcconnex

mod/gcforums/start.php

Doc Comments +4 added lines

@@ -606,6 +606,10 @@
 
 
 /// recursively go through the nested forums to create the breadcrumb
+/**
+ * @param integer $forum_guid
+ * @param integer $recurse_forum_guid
+ */
 function assemble_nested_forums($breadcrumb, $forum_guid, $recurse_forum_guid) {
 	$lang = get_current_language();
 	$entity = get_entity($recurse_forum_guid);

engine/lib/users.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
  *
  * @param int $guid The GUID
  *
- * @return \ElggUser|false
+ * @return ElggEntity
  */
 function get_user($guid) {
 	return _elgg_services()->entityTable->get($guid, 'user');

mod/pleio/classes/ModPleio/AccessRequest.php

Doc Comments +4 added lines

@@ -69,6 +69,10 @@
         return delete_data("DELETE FROM pleio_request_access WHERE id = {$this->id}");
     }
 
+    /**
+     * @param string $subject
+     * @param string $body
+     */
     private function sendEmail($subject, $body, $params = null) {
         $site = elgg_get_site_entity();
 

mod/pleio/classes/ModPleio/Helpers.php

Doc Comments +4 added lines

@@ -2,6 +2,10 @@
 namespace ModPleio;
 
 class Helpers {
+
+    /**
+     * @return string
+     */
     public static function generateUsername($username) {
         $hidden = access_show_hidden_entities(true);
 

mod/gc_mobile_api/models/wire.php

Doc Comments +3 added lines

@@ -109,6 +109,9 @@
 	false
 );
 
+/**
+ * @param ElggUser $user_entity
+ */
 function wires_foreach($wire_posts, $user_entity)
 {
 	foreach ($wire_posts as $wire_post) {

engine/lib/input.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
  * @param mixed $var Anything that does not include an object (strings, ints, arrays)
  *					 This includes multi-dimensional arrays.
  *
- * @return mixed The filtered result - everything will be strings
+ * @return string The filtered result - everything will be strings
  */
 function filter_tags($var) {
 	return elgg_trigger_plugin_hook('validate', 'input', null, $var);

mod/thewire/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -258,7 +258,7 @@ 
  * @param int    $access_id   Public/private etc
  * @param int    $parent_guid Parent post guid (if any)
  * @param string $method      The method (default: 'site')
- * @return guid or false if failure
+ * @return integer or false if failure
  */
 function thewire_save_post($text, $userid, $access_id, $parent_guid = 0, $method = "site") {
 	$post = new ElggObject();
@@ -473,7 +473,7 @@ 
 /**
  * Runs unit tests for the wire
  *
- * @return array
+ * @return string[]
  */
 function thewire_test($hook, $type, $value, $params) {
 	global $CONFIG;

mod/phpmailer/start.php

Doc Comments +6 added lines, -4 removed lines

@@ -29,7 +29,7 @@ 
  * @param string $subject The subject of the message.
  * @param string $message The message body
  * @param array $params Optional parameters (not used)
- * @return bool
+ * @return null|boolean
  */
 function phpmailer_notify_handler(ElggEntity $from, ElggUser $to, $subject, $message, array $params = NULL) {
 
@@ -72,6 +72,7 @@ 
  * This is a stupid function pulled from original Elgg code
  *
  * @param  ElggEntity The entity sending the message
+ * @param ElggEntity $from
  * @return string with email address
  */
 function phpmailer_extract_from_email($from) {
@@ -98,8 +99,6 @@ 
 /**
  * Send an email using phpmailer
  *
- * @param string $from       From address
- * @param string $from_name  From name
  * @param string $to         To address
  * @param string $to_name    To name
  * @param string $subject    The subject of the message.
@@ -110,7 +109,7 @@ 
  * @param array  $files      Array of file descriptor arrays, each file array
  *                           consists of full path and name
  * @param array  $params     Additional parameters
- * @return bool
+ * @return null|boolean
  */
 function phpmailer_send($to, $to_name, $subject, $body, array $bcc = NULL, $html = true, array $files = NULL, array $params = NULL, $image = NULL) {
 
@@ -255,6 +254,9 @@ 
 
 
 
+/**
+ * @param string $type
+ */
 function phpmailer_logging($errMess, $errStack, $type, $errType) {
 	// logging mechanism
 	if (elgg_is_active_plugin('wet4')) {

mod/gc_mobile_api/models/blog.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
  false
 );
 
+/**
+ * @param ElggUser $user_entity
+ */
 function foreach_blogs($blogs, $user_entity, $lang)
 {
 	foreach ($blogs as $blog_post) {