gctools-outilsgc / gcconnex

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/gcRegistration/actions/registerAJAX.php

Doc Comments +2 added lines, -2 removed lines

@@ -141,7 +141,7 @@ 
  * Checks for invalid / external domains
  * 
  * @param  $domain <string> domain part of the user's email address
- * @return true if domain is invalid, false otherwise
+ * @return boolean if domain is invalid, false otherwise
  * 
  **/
 function checkInvalidDomain($dom) 
@@ -195,7 +195,7 @@ 
  * Array key is the character to remove and the associated item is what will replace it.
  *
  * @param  $emailInput <string> users email address
- * @return always returns "" because we use the response text directly
+ * @return string returns "" because we use the response text directly
  * @author Matthew April <Matthew.April@tbs-sct.gc.ca>
  */
 

mod/gcRegistration_collab/actions/registerAJAX.php

Doc Comments +2 added lines, -2 removed lines

@@ -194,7 +194,7 @@ 
  * 
  * @param  $domain <string> domain part of the user's email address
  * @param  $email <string> the user's full email address
- * @return true if domain is invalid, false otherwise
+ * @return boolean if domain is invalid, false otherwise
  * 
  **/
 function checkInvalidDomain($dom, $email){
@@ -251,7 +251,7 @@ 
  * Array key is the character to remove and the associated item is what will replace it.
  *
  * @param  $emailInput <string> users email address
- * @return always returns "" because we use the response text directly
+ * @return string returns "" because we use the response text directly
  * @author Matthew April <Matthew.April@tbs-sct.gc.ca>
  */
 

mod/group_tools/lib/functions.php

Doc Comments +1 added lines, -1 removed lines

@@ -446,7 +446,7 @@
  * @param int    $group_guid the group GUID
  * @param string $email      the email address
  *
- * @return boolean|string the invite code, or false on failure
+ * @return string|false the invite code, or false on failure
  */
 function group_tools_generate_email_invite_code($group_guid, $email) {
 	$result = false;

mod/group_tools/lib/hooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -685,7 +685,7 @@
  * @param bool   $return_value true, return false to stop the action
  * @param null   $params       passed on params
  *
- * @return bool
+ * @return boolean|null
  */
 function group_tools_join_group_action_handler($hook, $type, $return_value, $params) {
 	// hacky way around a short comming of Elgg core to allow users to join a group

mod/groups/start.php

Doc Comments +2 added lines, -2 removed lines

@@ -939,7 +939,7 @@ 
  * @param string $type
  * @param string $return
  * @param array  $params
- * @return bool
+ * @return false|null
  */
 function discussion_comment_override($hook, $type, $return, $params) {
 	if (elgg_instanceof($params['entity'], 'object', 'groupforumtopic')) {
@@ -1290,7 +1290,7 @@ 
 /**
  * Runs unit tests for groups
  *
- * @return array
+ * @return string[]
  */
 function groups_test($hook, $type, $value, $params) {
 	global $CONFIG;

mod/htmlawed/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -191,7 +191,7 @@
 /**
  * Runs unit tests for htmlawed
  *
- * @return array
+ * @return string[]
  */
 function htmlawed_test($hook, $type, $value, $params) {
     $value[] = dirname(__FILE__) . '/tests/tags.php';

mod/mentions/start.php

Doc Comments -2 removed lines

@@ -51,8 +51,6 @@
  * Rewrites a view for @username mentions.
  *
  * @param string $hook    The name of the hook
- * @param string $type    The type of the hook
- * @param string $content The content of the page
  * @return string
  */
 function mentions_rewrite($hook, $entity_type, $returnvalue, $params) {

mod/messages/start.php

Doc Comments +1 added lines, -1 removed lines

@@ -630,7 +630,7 @@
  * @param string $return_value
  * @param array  $params
  *
- * @return array
+ * @return string
  */
 function messages_ecml_views_hook($hook, $entity_type, $return_value, $params) {
 	$return_value['messages/messages'] = elgg_echo('messages');