Minor - Adapting code comments to phpdoc

main/cron/cleanup.php

@@ -1,4 +1,12 @@
 <?php
+/**
+ * Automatic cleanup procedure
+ * @package chamilo.cron
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
+ */
+/**
+ * Initialization
+ */
 if (php_sapi_name() != 'cli') { exit; } //do not run from browser
 $dir = dirname(__FILE__);
 $a_dir = realpath($dir.'/../../archive/');

main/cron/notification.php

@@ -4,10 +4,15 @@
  * @package chamilo.notification
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 $language_file = array('userInfo');
 
 require_once '../inc/global.inc.php';
 require_once api_get_path(LIBRARY_PATH).'notification.lib.php';
+/**
+ * Notification sending
+ */
 $notify = new Notification();
-$notify->send();
+$notify->send();

main/cron/run.php

@@ -4,6 +4,7 @@
  * For more information, check the installation guide in the documentation 
  * folder. 
  * Add your own executable scripts below the inclusion of notification.php
+ * @package chamilo.cron
  */
 /**
  * Settings that will influence the execution of the cron tasks
@@ -16,4 +17,4 @@
  */
 error_log('[chamilo][cronjob] Starting cron jobs as process '.getmypid());
 require_once 'notification.php';
-error_log('[chamilo][cronjob] Ending cron jobs of process '.getmypid());
+error_log('[chamilo][cronjob] Ending cron jobs of process '.getmypid());

main/social/friends.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 $language_file = array('userInfo');
 $cidReset=true;
 require '../inc/global.inc.php';
@@ -175,4 +177,4 @@ if (count($friends) == 0 ) {
 	}	
 	echo '</div>';
 	echo '</div>';	
-Display :: display_footer();
+Display :: display_footer();

main/social/group_add.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 $language_file= 'userInfo';
 $cidReset=true;
 require_once '../inc/global.inc.php';
@@ -122,4 +124,4 @@ echo '<div id="social-content">';
     $form->display();	
     echo '</div>';
 echo '</div>';
-Display :: display_footer();
+Display :: display_footer();

main/social/group_edit.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 // Language files that should be included
 $language_file = array('userInfo');
 $cidReset = true;
@@ -170,4 +172,4 @@ echo '<div id="social-content">';
 echo '</div>';
 
 // Footer
-Display::display_footer();
+Display::display_footer();

main/social/group_invitation.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 // name of the language file that needs to be included
 $language_file=array('userInfo');
 
@@ -582,4 +584,4 @@ function makepost(select) {
 </script>
 <?php
 /* 		FOOTER */
-Display::display_footer();
+Display::display_footer();

main/social/group_members.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
- 
+/**
+ * Initialization
+ */
 $language_file = array('userInfo');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -141,4 +143,4 @@ echo '<div id="social-content">';
 	echo '</div>';
 echo '</div>';
 
-Display :: display_footer();
+Display :: display_footer();

main/social/group_topics.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
- 
+/**
+ * Initialization
+ */
 $language_file = array('userInfo', 'forum');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -166,4 +168,4 @@ echo '<div id="social-content">';
     echo '</div>';
 echo '</div>';
 
-Display :: display_footer();
+Display :: display_footer();

main/social/group_waiting_list.php

@@ -4,6 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
+/**
+ * Initialization
+ */
 $cidReset = true;
 $language_file = array('userInfo');
 require '../inc/global.inc.php';
@@ -114,4 +117,4 @@ echo '</div>';
 
 	
 Display :: display_footer();
-?>
+?>

main/social/groups.php

@@ -4,6 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
+/**
+ * Initialization
+ */
 $cidReset = true;
 $language_file = array('userInfo');
 require_once '../inc/global.inc.php';
@@ -524,4 +527,4 @@ if ($group_id != 0 ) {
     }
 	echo '</div>';
 echo '</div>';
-Display :: display_footer();
+Display :: display_footer();

main/social/home.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
-
+/**
+ * Initialization
+ */
 $language_file = array('userInfo');
 $cidReset = true;
 

main/social/invitations.php

@@ -4,6 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
+/**
+ * Initialization
+ */
 $language_file = array('messages','userInfo');
 $cidReset=true;
 require '../inc/global.inc.php';
@@ -230,4 +233,4 @@ echo '<div id="social-content">';
 		
 	echo '</div>';
 echo '</div>';
-Display::display_footer();
+Display::display_footer();

main/social/message_for_group_form.inc.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Form for group message
+ * @package chamilo.social
+ */
+/**
+ * Initialization
+ */
 $language_file = array('registration','messages','userInfo','admin');
 $cidReset=true;
 require_once '../inc/global.inc.php';
@@ -117,4 +124,4 @@ $page_topic  = !empty($_GET['topics_page_nr'])?intval($_GET['topics_page_nr']):1
 </tr>
 </div>
 </table>
-</form>
+</form>

main/social/myfiles.php

@@ -2,6 +2,10 @@
 /* For licensing terms, see /license.txt */
 /**
  * @author Juan Carlos Trabado herodoto@telefonica.net
+ * @package chamilo.social
+ */
+/**
+ * Initialization
  */
 $language_file = array('messages','userInfo');
 $cidReset=true;
@@ -108,4 +112,4 @@ echo '<div id="social-content">';
         echo '<table><tr><td><iframe name="fileManager" id="fileManager" src="'.api_get_path(WEB_PATH).'main/inc/lib/fckeditor/editor/plugins/ajaxfilemanager/ajaxfilemanager.php?editor=stand_alone" scrolling="no" noresize="noresize" frameborder="no" style="height:450px; width:710px; float:left"></iframe></td></tr></table>';
 	echo '</div>';
 echo '</div>';	
-Display::display_footer();
+Display::display_footer();

main/social/profile.php

@@ -6,7 +6,9 @@
 * @author Isaac Flores Paz <florespaz_isaac@hotmail.com>
 * @package chamilo.social
 */
-
+/**
+ * Initialization
+ */
 $language_file = array('userInfo');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -650,4 +652,4 @@ if ($show_full_profile) {
 echo '</div>';
 echo '</div>';
 
-Display :: display_footer();
+Display :: display_footer();

main/social/profile_friends_and_groups.inc.php

@@ -1,5 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Helper file for friends and groups profiles
+ * @package chamilo.social
+ * @author Julio Montoya <gugli100@gmail.com>
+ */
+/**
+ * Initialization
+ */
 $language_file = array('registration','messages','userInfo','admin');
 $cidReset=true;
 require_once '../inc/global.inc.php';
@@ -110,4 +118,4 @@ if (isset($_GET['view']) && in_array($_GET['view'], $views)) {
 			echo '</div>';	
 		}		
 	}	
-}
+}

main/social/search.php

@@ -4,7 +4,9 @@
  * @package chamilo.social
  * @author Julio Montoya <gugli100@gmail.com>
  */
- 
+/**
+ * Initialization
+ */
 // name of the language file that needs to be included
 $language_file = array('registration','admin','userInfo');
 $cidReset = true;
@@ -161,4 +163,4 @@ echo '<div id="social-content">';
 							
 	echo '</div>';
 echo '</div>';
-Display :: display_footer();
+Display :: display_footer();