gctools-outilsgc / gcconnex

mod/missions_collab/lib/missions.php

Doc Comments +26 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();
@@ -429,6 +446,9 @@ 
  * Notify user function which uses messages_send() to send on site notifications and mail() to send e-mail.
  * This is here because notify_user() is currently not working.
  */
+/**
+ * @param string $body
+ */
 function mm_notify_user($recipient, $sender, $subject, $body) {
 	//notify_user($recipient, $sender, $subject, $body, array(), 'email');
 
@@ -558,6 +578,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 +746,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') {

mod/gcforums/start.php

Doc Comments +11 added lines

@@ -127,6 +127,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);
@@ -226,6 +229,9 @@ 
 
 
 
+/**
+ * @param ElggEntity $entity
+ */
 function assemble_forum_breadcrumb($entity)
 {
 	$forum_guid = $entity->guid;
@@ -523,6 +529,7 @@ 
  * TOTAL_POST : 1
  * TOTAL_TOPICS : 2
  * RECENT_POST : 3
+ * @param integer $type
  */
 function get_forums_statistics_information($container_guid, $type)
 {
@@ -672,6 +679,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