Minor - Adapting code comments to phpdoc

main/course_info/delete_course.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This script is about deleting a course.
  *	It displays a message box ('are you sure you wish to delete this course')
@@ -8,6 +7,9 @@
  *
  *	@package chamilo.course_info
  */
+/**
+ * Code
+ */
 
 // Language files that need to be included
 $language_file = array('admin', 'course_info');

main/course_info/download.lib.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Course info library
+ * @package chamilo.course_info
+ */
+/**
+ * Code
+ */
 
 // TODO: Where this file is used? Is it needed at all?
 

main/course_info/download.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Download script for course info
+ * @package chamilo.course_info
+ */
+/**
+ * Code
+ */
 //session_cache_limiter('public');
 require_once '../inc/global.inc.php';
 $this_section = SECTION_COURSES;
@@ -48,4 +55,4 @@ if (Security::check_abs_path($archive_path.$archive_file, $archive_path)) {
     readfile($archive_path.$archive_file);
 } else {
     api_not_allowed(true);
-}
+}

main/course_info/infocours.php

@@ -6,13 +6,17 @@
  *	and activate the changes.
  *
  *	See ./inc/conf/course_info.conf.php for settings
- * @todo: Move $canBeEmpty from course_info.conf.php to config-settings
- * @todo: Take those config settings into account in this script
+ * @todo Move $canBeEmpty from course_info.conf.php to config-settings
+ * @todo Take those config settings into account in this script
  * @author Patrick Cool <patrick.cool@UGent.be>
  * @author Roan Embrechts, refactoring
  * and improved course visibility|subscribe|unsubscribe options
  * @package chamilo.course_info
  */
+/**
+ * Code
+ */
+
 
 /*	   INIT SECTION */
 
@@ -514,4 +518,4 @@ if ($showDiskQuota && $currentCourseDiskQuota != '') {
 }
 */
 
-Display::display_footer();
+Display::display_footer();

main/course_info/maintenance.php

@@ -1,8 +1,11 @@
 <?php
 /* For licensing terms, see /license.txt */
-
-/*
- * Created on 18 October 2006 by Elixir Interactive http://www.elixir-interactive.com
+/**
+ * @author Created on 18 October 2006 by Elixir Interactive http://www.elixir-interactive.com
+ * @package chamilo.course_info
+ */
+/**
+ * Code
  */
 
 // Language files that need to be included

main/course_info/postpone.php

@@ -19,6 +19,9 @@
  *
  * @package chamilo.course_info
  */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 

main/help/allowed_html_tags.php

@@ -7,6 +7,9 @@
  *
  *	@package chamilo.help
  */
+/**
+ * Code
+ */
 
 // Language file that needs to be included
 $language_file = 'help';
@@ -66,4 +69,4 @@ Display::display_sortable_table($table_header, $table_data, array(), array(), ar
 <div style="text-align:right;"><a href="javascript: window.close();"><?php echo get_lang('Close'); ?></a></div>
 </div>
 </body>
-</html>
+</html>

main/help/faq.php

@@ -6,6 +6,9 @@
  *
  *	@package chamilo.help
  */
+/**
+ * Code
+ */
 
 // Language file that needs to be included
 $language_file = 'help';
@@ -85,4 +88,4 @@ if (!empty($_GET['edit']) && $_GET['edit'] == 'true' && api_is_platform_admin())
 <div style="text-align:right;"><a href="javascript: window.close();"><?php echo get_lang('Close'); ?></a></div>
 </div>
 </body>
-</html>
+</html>

main/help/help.php

@@ -6,6 +6,9 @@
  *
  *	@package chamilo.help
  */
+/**
+ * Code
+ */
 
 // Language file that needs to be included
 $language_file = 'help';
@@ -22,4 +25,4 @@ Display::display_reduced_header();
     <?php echo get_lang($help_name.'Content'); ?>
     <br /><br />
     <a href="<?php echo api_get_path(WEB_CODE_PATH); ?>help/faq.php"><?php echo get_lang('AccessToFaq'); ?></a>
-</div>
+</div>

main/notebook/index.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- * @package chamilo.glossary
+ * @package chamilo.notebook
  * @author Christian Fasanando, initial version
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium, refactoring and tighter integration
  */
-
+/**
+ * Code
+ */
 // Name of the language file that needs to be included
 $language_file = array('notebook');
 

main/tracking/courseLog.php

@@ -4,6 +4,9 @@
 /**
  *	@package chamilo.tracking
  */
+/**
+ * Code
+ */
 
 /* INIT SECTION */
 

main/tracking/courseLogCSV.php

@@ -10,6 +10,9 @@
  *
  *	@package chamilo.tracking
  */
+/**
+ * Code
+ */
 
 // TODO: Is this file deprecated?
 
@@ -464,4 +467,4 @@ if ($is_allowedToTrack) {
     exit;
 } else {
     api_not_allowed();
-}
+}

main/tracking/course_access_details.php

@@ -8,6 +8,9 @@
 *
 *	@package chamilo.tracking
 */
+/**
+ * Code
+ */
 
 // TODO: Is this file deprecated?
 
@@ -215,4 +218,4 @@ $is_allowedToTrack = $is_courseAdmin;
 ?>
 </table>
 <?php
-Display::display_footer();
+Display::display_footer();

main/tracking/course_session_report.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Report
+ * @package chamilo.tracking
+ */
+/**
+ * Code
+ */
 $language_file = array ('registration', 'index', 'tracking', 'exercice','survey');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -290,4 +297,4 @@ function export_complete_report_xls($filename, $array) {
 		exit;
 }
 
-Display :: display_footer();
+Display :: display_footer();

main/tracking/exams.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Exams script
+ * @package chamilo.tracking
+ */
+/**
+ * Code
+ */
 
 $language_file = array ('registration', 'index', 'tracking', 'exercice','survey');
 
@@ -524,4 +531,4 @@ function export_complete_report_xls($filename, $array) {
 		$workbook->close();
 		exit;
 }
-Display :: display_footer();
+Display :: display_footer();

main/tracking/logins_details.php

@@ -6,9 +6,12 @@
 *	@author Christophe Gesche
 *	@author Sebastien Piraux
 *
-*	@package dokeos.tracking
+*	@package chamilo.tracking
 
 */
+/**
+ * Code
+ */
 
 // TODO: Is this file deprecated?
 

main/tracking/lp_results_by_user.php

@@ -5,7 +5,10 @@
  * Exercise results from Learning paths
  * 
  * @todo implement pagination
- * 
+ * @package chamilo.tracking
+ */
+/**
+ * Code
  */
 
 $language_file = array ('registration', 'index', 'tracking', 'exercice','survey');
@@ -268,4 +271,4 @@ function export_complete_report_csv($filename, $array) {
 		$workbook->close();
 		exit;*/
 }
-Display :: display_footer();
+Display :: display_footer();

main/tracking/personnalLog.php

@@ -9,6 +9,9 @@
 *	@package chamilo.tracking
 */
 
+/**
+ * Code
+ */
 // TODO: Is this file deprecated?
 
 /*
@@ -270,4 +273,4 @@ api_display_tool_title($nameTools);
     }
     */
     echo "</table>";
-Display::display_footer();
+Display::display_footer();

main/tracking/question_course_report.php

@@ -1,4 +1,11 @@
 <?php
+/**
+ * Report
+ * @package chamilo.tracking
+ */
+/**
+ * Code
+ */
 $language_file = array ('registration', 'index', 'tracking', 'exercice','survey');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -281,4 +288,4 @@ function export_complete_report_xls($filename, $array) {
 		exit;
 }
 
-Display :: display_footer();
+Display :: display_footer();

main/tracking/toolaccess_details.php

@@ -3,15 +3,16 @@
 // TODO: Is this file deprecated?
 
 /**
-==============================================================================
 *	@author Thomas Depraetere
 *	@author Hugues Peeters
 *	@author Christophe Gesche
 *	@author Sebastien Piraux
 *
-*	@package dokeos.tracking
-==============================================================================
+*	@package chamilo.tracking
 */
+/**
+ * Code
+ */
 
 /*
 ==============================================================================
@@ -273,4 +274,4 @@ $reqdate=$_REQUEST['reqdate'];
     }
 echo '</table>';
 // footer
-Display::display_footer();
+Display::display_footer();

main/tracking/userLog.php

@@ -7,6 +7,9 @@
  * @package chamilo.tracking
  * @todo clean code - structure is unclear and difficult to modify
  */
+/**
+ * Code
+ */
 
 /* INIT SECTION */
 

main/tracking/userlogCSV.php

@@ -7,6 +7,9 @@
  * @package chamilo.tracking
  * @todo clean code - structure is unclear and difficult to modify
  */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 

main/user/class.php

@@ -3,9 +3,9 @@
 /**
 *	@package chamilo.user
 */
-/*
-		INIT SECTION
-*/
+/**
+ * INIT SECTION
+ */
 // name of the language file that needs to be included
 $language_file = array('registration','admin');
 include ('../inc/global.inc.php');
@@ -16,7 +16,9 @@ require_once (api_get_path(LIBRARY_PATH).'sortabletable.class.php');
 require_once (api_get_path(LIBRARY_PATH).'classmanager.lib.php');
 require_once (api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php');
 
-/*		MAIN CODE	*/
+/**
+ * MAIN CODE	
+ */
 
 api_protect_course_script();
 
@@ -154,4 +156,4 @@ $form->display();
 echo '<br />';
 $table->display();
 
-Display :: display_footer();
+Display :: display_footer();

main/user/classes.php

@@ -4,6 +4,9 @@
  * @package chamilo.classes
  * @author Julio Montoya <gugli100@gmail.com>
  */
+/**
+ * Init
+ */
 
 $language_file = array('userInfo','admin');
 $cidReset=true;
@@ -42,4 +45,4 @@ if (!empty($usergroup_list)) {
     }
 }
 
-Display :: display_footer();
+Display :: display_footer();

main/user/subscribe_class.php

@@ -3,6 +3,9 @@
 /**
 *	@package chamilo.user
 */
+/**
+ * Code
+ */
 
 // name of the language file that needs to be included
 $language_file = array('registration','admin');
@@ -172,4 +175,4 @@ $form->display();
 echo '<br />';
 $table->display();
 
-Display :: display_footer();
+Display :: display_footer();

main/user/user.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
 *	This script displays a list of the users of the current course.
 *	Course admins can change user perimssions, subscribe and unsubscribe users...
@@ -20,7 +19,9 @@
 *	@author Julio Montoya Armas, Several fixes
 *	@package chamilo.user
 */
-
+/**
+ * Code
+ */
 
 /*	   INIT SECTION	*/
 // name of the language file that needs to be included
@@ -671,4 +672,4 @@ show_users_in_virtual_courses($is_allowed_to_track);
 /*		FOOTER  */
 if ($origin != 'learnpath') {
 	Display::display_footer();
-}
+}

main/user/userInfo.php

@@ -15,7 +15,9 @@
 *	@package chamilo.user
 */
 
-/*	   INIT SECTION		*/
+/**
+ *  INIT SECTION
+ */
 
 // name of the language file that needs to be included
 $language_file = array ('registration', 'userInfo');
@@ -81,11 +83,9 @@ $current_session_id = api_get_session_id();
 //get information about one user
 $userIdViewed = Security::remove_XSS($_REQUEST['uInfo']);
 
-/*
------------------------------------------------------------
-	Connection layer between Dokeos and the current script
------------------------------------------------------------
-*/
+/**
+ * Connection layer between Chamilo and the current scrip:t
+ */
 
 
 $mainDB = $_configuration['main_database'];
@@ -102,7 +102,9 @@ $is_allowedToTrack = api_is_allowed_to_edit(null, true);
 // Library connection
 require_once ("userInfoLib.php");
 
-/* 	   FUNCTIONS */
+/**
+ *  FUNCTIONS 
+ */
 
 /* 	   COMMANDS SECTION */