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/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/missions_collab/lib/missions.php

Doc Comments +23 added lines

@@ -10,6 +10,12 @@ 
 /*
  * Packs the language variables for a single language into a single string.
  */
+/**
+ * @param string|null $lwc
+ * @param string|null $lwe
+ * @param string|null $lop
+ * @param string|null $lang
+ */
 function mm_pack_language($lwc, $lwe, $lop, $lang)
 {
     $returner = '';
@@ -41,6 +47,9 @@ 
 /*
  * Unpacks a language string into an array of its component variable.
  */
+/**
+ * @param string|null $lang
+ */
 function mm_unpack_language($data_string, $lang)
 {
     $returner = array();
@@ -71,6 +80,11 @@ 
 /*
  * Packs the time (hour and minute) into a single string.
  */
+/**
+ * @param string|null $hour
+ * @param string|null $min
+ * @param string|null $day
+ */
 function mm_pack_time($hour, $min, $day)
 {
     $returner = '';
@@ -95,6 +109,9 @@ 
 /*
  * Unpacks the time into an array of hour and minute.
  */
+/**
+ * @param string|null $day
+ */
 function mm_unpack_time($data_string, $day)
 {
     $returner = array();
@@ -558,6 +575,9 @@ 
 /*
  * Returns an accept button to a user who has received an offer if the mission is not full.
  */
+/**
+ * @param ElggUser|null $applicant
+ */
 function mm_finalize_button($mission, $applicant) {
 	$relationship_count = elgg_get_entities_from_relationship(array(
 			'relationship' => 'mission_accepted',
@@ -723,6 +743,9 @@ 
 /*
  * Check if the user is opted in to any of the opt-in options.
  */
+/**
+ * @param ElggEntity|null $current_user
+ */
 function check_if_opted_in($current_user) {
     //Nick - adding additional checks for other opportunity types
 	if($current_user->opt_in_missions == 'gcconnex_profile:opt:yes') {