gctools-outilsgc / gcconnex

mod/cp_notifications/lib/functions.php

Doc Comments +2 added lines, -1 removed lines

@@ -6,6 +6,7 @@ 
  * @param integer 	$entity_guid_static
  * @param integer 	$entity_guid
  *
+ * @return integer
  */
 function get_forum_in_group($entity_guid_static, $entity_guid) {
 	$entity = get_entity($entity_guid);
@@ -159,7 +160,7 @@ 
  * @param ElggEntity 	$entity
  * @param ElggUser 		$send_to
  * @param string 		$entity_url (default value empty)
- * @return Success 		true/false
+ * @return boolean 		true/false
  */
 function create_digest($invoked_by, $subtype, $entity, $send_to, $entity_url = '') {
 

mod/cp_notifications/start.php

Doc Comments +4 added lines, -6 removed lines

@@ -132,7 +132,7 @@ 
  * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  *
- * @return mixed if not null, this will be the new value of the plugin hook
+ * @return boolean if not null, this will be the new value of the plugin hook
  */
 function minor_save_hook_handler($hook, $type, $value, $params) {
 
@@ -542,7 +542,6 @@ 
 /**
  * returns the headers for ical
  *
- * @param string 		$type_event
  * @param ElggObject 	$event
  * @param string 		$start_date
  * @param string 		$end_date
@@ -1357,6 +1356,9 @@ 
 }
 
 
+/**
+ * @param string $error_message
+ */
 function notification_logging($error_message) {
 	// logging mechanism
 	if (elgg_is_active_plugin('wet4')) {
@@ -1407,8 +1409,6 @@ 
  * run crontab, retrieve users, send digest, reset timer (update timestamp)
  *
  * @param string $hook    The name of the plugin hook
- * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  */
 function cp_digest_weekly_cron_handler($hook, $entity_type, $return_value, $params) {
@@ -1674,7 +1674,6 @@ 
  *
  * @param string $hook    The name of the plugin hook
  * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  */
 function cpn_email_handler_hook($hook, $type, $notification, $params) {
@@ -1688,7 +1687,6 @@ 
  *
  * @param string $hook    The name of the plugin hook
  * @param string $type    The type of the plugin hook
- * @param mixed  $value   The current value of the plugin hook
  * @param mixed  $params  Data passed from the trigger
  *
  * @return mixed if not null, this will be the new value of the plugin hook

mod/gcforums/start.php

Doc Comments +11 added lines

@@ -126,6 +126,9 @@ 
 }
 
 /// recursively go through the forums and return group entity
+/**
+ * @return integer
+ */
 function gcforums_get_forum_in_group($entity_guid_static, $entity_guid) {
 	$entity = get_entity($entity_guid);
 	// (base) stop recursing when we reach group guid
@@ -220,6 +223,9 @@ 
 
 
 
+/**
+ * @param ElggEntity $entity
+ */
 function assemble_forum_breadcrumb($entity) {
 	$forum_guid = $entity->guid;
 	if ($entity instanceof ElggGroup) {
@@ -511,6 +517,7 @@ 
  * TOTAL_POST : 1
  * TOTAL_TOPICS : 2
  * RECENT_POST : 3
+ * @param integer $type
  */
 function get_forums_statistics_information($container_guid, $type) {
 	$dbprefix = elgg_get_config('dbprefix');
@@ -662,6 +669,10 @@ 
 
 
 
+/**
+ * @param integer|null $forum_guid
+ * @param integer|null $group_guid
+ */
 function gcforums_menu_buttons($forum_guid, $group_guid, $is_topic=false) { 
 	// main page if forum_guid is not present
 	elgg_load_css('gcforums-css');

mod/uservalidationbyemail/start.php

Doc Comments +3 added lines, -3 removed lines

@@ -62,7 +62,7 @@ 
  * @param string $type
  * @param bool   $value
  * @param array  $params
- * @return bool
+ * @return null|boolean
  */
 function uservalidationbyemail_disable_new_user($hook, $type, $value, $params) {
 	$user = elgg_extract('user', $params);
@@ -155,7 +155,7 @@ 
  * Checks if an account is validated
  *
  * @params array $credentials The username and password
- * @return bool
+ * @return boolean|null
  */
 function uservalidationbyemail_check_auth_attempt($credentials) {
 
@@ -234,7 +234,7 @@ 
  * @param string   $event
  * @param string   $type
  * @param ElggUser $user
- * @return bool
+ * @return false|null
  *
  * @throws LoginException
  */