Minor - Adapting code comments to phpdoc

main/admin/calendar.lib.php

@@ -25,7 +25,7 @@ $MonthsLong = api_get_months_long();
 
 /**
 * Retrieves all the agenda items from the table
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @author Yannick Warnier <yannick.warnier@dokeos.com> - cleanup
 * @param integer $month: the integer value of the month we are viewing
 * @param integer $year: the 4-digit year indication e.g. 2005
@@ -34,7 +34,7 @@ $MonthsLong = api_get_months_long();
 
 /**
 * show the mini calender of the given month
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @param array an array containing all the agenda items for the given month
 * @param integer $month: the integer value of the month we are viewing
 * @param integer $year: the 4-digit year indication e.g. 2005
@@ -110,14 +110,14 @@ function display_minimonthcalendar($agendaitems, $month, $year, $monthName) {
 }
 /**
 * show the calender of the given month
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @param integer $month: the integer value of the month we are viewing
 * @param integer $year: the 4-digit year indication e.g. 2005
 * @return html code
 */
 /**
 * returns all the javascript that is required for easily selecting the target people/groups this goes into the $htmlHeadXtra[] array
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @return javascript code
 */
 function to_javascript() {
@@ -284,7 +284,7 @@ function validate_date()
 
 /**
 * returns the javascript for setting a filter. This is a jump menu
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @return javascript code
 */
 function user_group_filter_javascript() {
@@ -378,12 +378,12 @@ function display_monthcalendar($month, $year) {
 }
 /**
 * this function shows the form with the user that were not selected
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @return html code
 */
 /**
 * This function stores the Agenda Item in the table calendar_event and updates the item_property table also
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @return integer the id of the last added agenda item
 */
 function store_new_agenda_item() {
@@ -542,7 +542,7 @@ function store_edited_agenda_item() {
 
 /**
 * This function stores the Agenda Item in the table calendar_event and updates the item_property table also (after an edit)
-* @author: Patrick Cool <patrick.cool@UGent.be>, Ghent University
+* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 */
 function save_edit_agenda_item($id, $title, $content, $start_date, $end_date) {
 	$TABLEAGENDA = Database::get_main_table(TABLE_MAIN_SYSTEM_CALENDAR);

main/course_progress/index.php

@@ -1,13 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
 * Template (front controller in MVC pattern) used for distpaching to the controllers depend on the current action
 * @author Christian Fasanando <christian1827@gmail.com>
 * @author Julio Montoya <gugli100@gmail.com> Bugfixes session support
 * @package chamilo.course_progress
 */
-
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file = array ('course_description', 'pedaSuggest', 'userInfo', 'admin');
 
@@ -219,4 +220,4 @@ switch ($action) {
     case 'thematic_advance_list'    : 
         $thematic_controller->thematic_advance($action);
         break;
-}
+}

main/coursecopy/classes/ForumTopic.class.php

@@ -4,11 +4,15 @@
  * Forum topic backup script
  * @package chamilo.backup
  */
+/**
+ * Code
+ */
 require_once 'Resource.class.php';
 
 /**
  * A forum-topic/thread
  * @author Bart Mollet <bart.mollet@hogent.be>
+ * @package chamilo.backup
  */
 class ForumTopic extends Resource
 {

main/dropbox/dropbox_download.php

@@ -1,6 +1,11 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * @package chamilo.dropbox
+ */
+/**
+ * Code
+ */
 /*	INIT SECTION */
 
 // We cannot use dropbox_init.inc.php because this one already outputs data.

main/dropbox/dropbox_init.inc.php

@@ -23,7 +23,9 @@
  				extended feedback
  * @package chamilo.dropbox
  */
-
+/**
+ * Code
+ */
 /*	INIT SECTION */
 
 $language_file = 'dropbox';

main/forum/forumfunction.inc.php

@@ -21,7 +21,9 @@
  * @todo displaying icons => display library
  * @todo complete the missing phpdoc the correct order should be
  */
-
+/**
+ * code
+ */
 require_once api_get_path(LIBRARY_PATH).'mail.lib.inc.php';
 require_once api_get_path(LIBRARY_PATH).'usermanager.lib.php';
 require_once api_get_path(SYS_CODE_PATH).'gradebook/lib/gradebook_functions.inc.php';
@@ -1737,8 +1739,7 @@ function get_forum_information($forum_id) {
  * This function retrieves all the information of a given forumcategory id
  *
  * @param $forum_id integer that indicates the forum
- * @return array returns if there are category
- * @return bool returns if there aren't category
+ * @return array returns if there are category or bool returns if there aren't category
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
  */
@@ -2152,7 +2153,7 @@ function store_theme_qualify($user_id, $thread_id, $thread_qualify = 0, $qualify
  * @param integer contains the information the current user id
  * @param integer contains the information the current thread id
  * @return integer qualify
- * @example $option=1 obtained the qualification of the current thread
+ * <code> $option=1 obtained the qualification of the current thread</code>
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */
@@ -2213,7 +2214,7 @@ function get_historical_qualify($user_id, $thread_id, $opt) {
  * @param integer contains the information the current thread id
  * @param integer contains the information the current qualify
  * @return void
- * @example $option=1 obtained the qualification of the current thread
+ * <code>$option=1 obtained the qualification of the current thread</code>
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */
@@ -2639,9 +2640,6 @@ function increase_thread_view($thread_id) {
 /**
  * The relies counter gets increased every time somebody replies to the thread
  *
- * @param
- * @return
- *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
  */
@@ -2711,9 +2709,6 @@ function get_whats_new() {
 /**
  * With this function we find the number of posts and topics in a given forum.
  *
- * @param
- * @return
- *
  * @todo consider to call this function only once and let it return an array where the key is the forum id and the value is an array with number_of_topics and number of post
  * as key of this array and the value as a value. This could reduce the number of queries needed (especially when there are more forums)
  * @todo consider merging both in one query.

main/forum/index.php

@@ -15,13 +15,15 @@
  * - new view option: nested view
  * - quoting a message
  *
- * @Author Patrick Cool <patrick.cool@UGent.be>, Ghent University
- * @Copyright Ghent University
- * @Copyright Patrick Cool
+ * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
+ * @copyright Ghent University
+ * @copyright Patrick Cool
  *
  * @package chamilo.forum
  */
-
+/**
+ * Code
+ */
 // Name of the language file that needs to be included.
 $language_file = 'forum';
 

main/survey/survey.lib.php

@@ -1,16 +1,16 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- *	@package chamilo.survey
- * 	@author Patrick Cool <patrick.cool@UGent.be>, Ghent University: cleanup, refactoring and rewriting large parts (if not all) of the code
- *	@author Julio Montoya Armas <gugli100@gmail.com>, Chamilo: Personality Test modification and rewriting large parts of the code
- * 	@version $Id: survey.lib.php 22296 2009-07-22 22:05:50Z cfasanando $
- *
- * 	@todo move this file to inc/lib
- * 	@todo use consistent naming for the functions (save vs store for instance)
+ * @package chamilo.survey
+ * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University: cleanup, refactoring and rewriting large parts (if not all) of the code
+ * @author Julio Montoya Armas <gugli100@gmail.com>, Chamilo: Personality Test modification and rewriting large parts of the code
+ * @version $Id: survey.lib.php 22296 2009-07-22 22:05:50Z cfasanando $
+ * @todo move this file to inc/lib
+ * @todo use consistent naming for the functions (save vs store for instance)
+ */
+/**
+ * Code
  */
-
 $config['survey']['debug'] = false;
 //require_once '../inc/global.inc.php';
 require_once api_get_path(LIBRARY_PATH).'sortabletable.class.php';
@@ -24,8 +24,10 @@ $htmlHeadXtra[] = '<script type="text/javascript" language="javascript">
 		  setFocus();
 		});
 	</script>';
-
-
+/**
+ * Survey manager class
+ * @package chamilo.survey
+ */
 class survey_manager {
 
 	/***
@@ -39,7 +41,6 @@ class survey_manager {
 	 * @param boolean $shared this parameter determines if we have to get the information of a survey from the central (shared) database or from the
 	 * 		  course database
 	 * @param string course code optional
-	 * @return array
 	 *
 	 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 	 * @version February 2007
@@ -980,7 +981,6 @@ class survey_manager {
 	 * This function stores the options of the questions in the table
 	 *
 	 * @param array $form_content
-	 * @return
 	 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 	 * @version January 2007
 	 *
@@ -1027,7 +1027,6 @@ class survey_manager {
 	 * This function stores the options of the questions in the shared table
 	 *
 	 * @param array $form_content
-	 * @return
 	 *
 	 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 	 * @version February 2007