Minor - Adapting code comments to phpdoc

main/inc/lib/auth.lib.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * This file contains a class used like library provides functions for auth tool. It's also used like model to courses_controller (MVC pattern)
  * @author Christian Fasanando <christian1827@gmail.com>
  * @package chamilo.auth
  */
-
+/**
+ * Code
+ */
 require_once api_get_path(LIBRARY_PATH).'tracking.lib.php';
 
 /**

main/inc/lib/classmanager.lib.php

@@ -4,6 +4,9 @@
 *	This is the class library for Dokeos.
 *	@package	 chamilo.library
 */
+/**
+ * Code
+ */
 require_once (api_get_path(LIBRARY_PATH).'course.lib.php');
 /**
  * This library contains some functions for class-management.
@@ -236,4 +239,4 @@ class ClassManager
 		return $classes;
 	}
 }
-?>
+?>

main/inc/lib/course.lib.php

@@ -17,7 +17,7 @@
  * @package chamilo.library
  */
 
-/*
+/**
     DOCUMENTATION
     (list not up to date, you can auto generate documentation with phpDocumentor)
 
@@ -3153,7 +3153,7 @@ class CourseManager {
      * Creates a new course code based in given code
      * 
      * @param string	wanted code
-     * @example	$wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3
+     * <code>	$wanted_code = 'curse' if there are in the DB codes like curse1 curse2 the function will return: course3</code>
      * if the course code doest not exist in the DB the same course code will be returned
      * @return string	wanted unused code
      */

main/inc/lib/database.constants.inc.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This is the database constants definition for Chamilo
  *  This file is called by database.lib.php and database.mysqli.lib.php  
@@ -11,7 +10,9 @@
  *	@package chamilo.library 
  */
 
-/*	CONSTANTS */
+/**
+ * CONSTANTS 
+ */
 
 // Main database tables
 define('TABLE_MAIN_COURSE',                 'course');

main/inc/lib/database.lib.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This is the main database library for Chamilo.
  *	Include/require it in your code to use its functionality.
@@ -13,7 +12,9 @@
  * 	@todo the table constants have all to start with TABLE_
  * 		  This is because of the analogy with the tool constants TOOL_
  */
-
+/**
+ * Code
+ */
 /*	CONSTANTS */
 
 require_once 'database.constants.inc.php';

main/inc/lib/database.mysqli.lib.php

@@ -19,10 +19,11 @@
 require_once 'database.constants.inc.php';
 
 
-/*		DATABASE CLASS
-        The class and its methods
-*/
-
+/**
+ * DATABASE CLASS
+ *      The class and its methods
+ *	@package chamilo.library
+ */
 class Database {
 
     /*
@@ -1253,4 +1254,4 @@ class Database {
     }
 
 }
-//end class Database
+//end class Database

main/inc/lib/display.lib.php

@@ -13,7 +13,10 @@
  *
  * @package chamilo.library
  */
-
+/**
+ * Code
+ */
+define('MAX_LENGTH_BREADCRUMB', 100);
 /**
  * Display class
  * contains several public functions dealing with the display of
@@ -22,8 +25,6 @@
  * @package chamilo.library
  */
 
-define('MAX_LENGTH_BREADCRUMB', 100);
-
 class Display {
 
     private function __construct() {
@@ -36,7 +37,7 @@ class Display {
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @param string $tool These are the constants that are used for indicating the tools.
      * @param array $editor_config Optional configuration settings for the online editor.
-     * @return $tool return a string array list with the "define" in main_api.lib
+     * return: $tool return a string array list with the "define" in main_api.lib
      * @return html code for adding an introduction
      */
     public static function display_introduction_section($tool, $editor_config = null) {
@@ -1285,4 +1286,4 @@ class Display {
         }
         return $output;
     }
-} //end class Display
+} //end class Display

main/inc/lib/main_api.lib.php

@@ -266,7 +266,7 @@ require_once dirname(__FILE__).'/internationalization.lib.php';
  * It has not been identified as needed yet.
  * 4. Also, resolving the meta-symbols "." and ".." withiin paths has not been implemented, it is to be identified as needed.
  *
- * @example
+ * Example:
  * Assume that your server root is /var/www/ , Chamilo is installed in a subfolder chamilo/ and the URL of your campus is http://www.mychamilo.org
  * The other configuration paramaters have not been changed.
  *
@@ -802,7 +802,7 @@ function api_is_self_registration_allowed() {
 /**
  * This function returns the id of the user which is stored in the $_user array.
  *
- * @example The function can be used to check if a user is logged in
+ * example: The function can be used to check if a user is logged in
  *          if (api_get_user_id())
  * @return integer the id of the current user, 0 if is empty
  */
@@ -1445,7 +1445,7 @@ $api_failureList = array();
  *
  * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  string $failure_type - the type of failure
- * @global array $api_failureList
+ * global: array $api_failureList
  * @return bolean false to stay consistent with the main script
  */
 function api_set_failure($failure_type) {
@@ -1820,8 +1820,8 @@ function api_is_course_tutor() {
 
 /**
  * Checks whether the current user is a course or session coach
- * @params int - optional, session id
- * @params string - optional, course code
+ * @param int - optional, session id
+ * @param string - optional, course code
  * @return boolean True if current user is a course or session coach
  */
 function api_is_coach($session_id = 0, $course_code = '') {
@@ -3396,6 +3396,7 @@ function api_chmod_R($path, $filemode) {
  * - package: The name of the package of modules this module belongs to.
  *
  * Example of .info file:
+ * <code>
  * @verbatim
  *   name = Forum
  *   description = Enables threaded discussions about general topics.
@@ -3404,7 +3405,7 @@ function api_chmod_R($path, $filemode) {
  *   package = Core - optional
  *   version = VERSION
  * @endverbatim
- *
+ * </code>
  * @param $filename
  *   The file we are parsing. Accepts file with relative or absolute path.
  * @return
@@ -4658,14 +4659,14 @@ function get_setting($variable, $key = NULL) {
 }
 
 /**
- * @deprecated, use api_is_allowed_to_edit() instead
+ * deprecated: use api_is_allowed_to_edit() instead
  */
 function is_allowed_to_edit() {
     return api_is_allowed_to_edit();
 }
 
 /**
- * @deprecated 19-SEP-2009: Use api_get_path(TO_SYS, $url) instead.
+ * deprecated: 19-SEP-2009: Use api_get_path(TO_SYS, $url) instead.
  */
 function api_url_to_local_path($url) {
     return api_get_path(TO_SYS, $url);
@@ -5080,4 +5081,4 @@ function api_get_multiple_access_url() {
 function api_get_unique_id() {    
     $id = md5(time().uniqid().api_get_user_id().api_get_course_id().api_get_session_id());    
     return $id;
-}
+}

main/inc/lib/message.lib.php

@@ -1,13 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
 *	This class provides methods for messages management.
 *	Include/require it in your code to use its features.
 *
 *	@package chamilo.library
 */
-
+/**
+ * Code
+ */
 require_once api_get_path(LIBRARY_PATH).'online.inc.php';
 require_once api_get_path(LIBRARY_PATH).'fileUpload.lib.php';
 require_once api_get_path(LIBRARY_PATH).'fileDisplay.lib.php';
@@ -26,7 +27,10 @@ define('MESSAGE_STATUS_OUTBOX',				'4');
 define('MESSAGE_STATUS_INVITATION_PENDING',	'5');
 define('MESSAGE_STATUS_INVITATION_ACCEPTED','6');
 define('MESSAGE_STATUS_INVITATION_DENIED',	'7');
-
+/**
+ * Class
+ * @package chamilo.library
+ */
 class MessageManager
 {
 	public static function get_online_user_list($current_user_id) {
@@ -1331,4 +1335,4 @@ function get_message_data_send_mask($from, $number_of_items, $column, $direction
 	//non set by SortableTable ?
 	$number_of_items=get_number_of_messages_send_mask();
 	return MessageManager::get_message_data_sent($from, $number_of_items, $column, $direction);
-}
+}

main/inc/lib/promotion.lib.php

@@ -1,19 +1,22 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
 *	This class provides methods for the promotion management.
 *	Include/require it in your code to use its features.
 *	@package chamilo.library
 */
-
+/**
+ * Code
+ */
 require_once 'model.lib.php';
 require_once 'career.lib.php';
 require_once 'fckeditor/fckeditor.php';
 
 define ('PROMOTION_STATUS_ACTIVE',  1);
 define ('PROMOTION_STATUS_INACTIVE',0);   
-
+/**
+ * @package chamilo.library
+ */
 class Promotion extends Model {
     
     var $table;
@@ -206,4 +209,4 @@ class Promotion extends Model {
     }
    
     
-}
+}

main/inc/lib/urlmanager.lib.php

@@ -6,6 +6,9 @@
 *
 *	@package chamilo.library
 */
+/**
+ * @package chamilo.library
+ */
 class UrlManager
 {
 	/**
@@ -147,7 +150,7 @@ class UrlManager
 
 	/** Gets the inner join of users and urls table
 	 * @author Julio Montoya
-	 * @return int  access url id
+	 * @param int  access url id
 	 * @return array   Database::store_result of the result
 	 * */
 	public static function get_url_rel_user_data($access_url_id='')
@@ -172,7 +175,7 @@ class UrlManager
 
 	 /** Gets the inner join of access_url and the course table
 	 * @author Julio Montoya
-	 * @return int  access url id
+	 * @param int  access url id
 	 * @return array   Database::store_result of the result
 	 * */
 	public static function get_url_rel_course_data($access_url_id='')
@@ -198,7 +201,7 @@ class UrlManager
 
 	/** Gets the inner join of access_url and the session table
 	 * @author Julio Montoya
-	 * @return int  access url id
+	 * @param int  access url id
 	 * @return array   Database::store_result of the result
 	 * */
 	public static function get_url_rel_session_data($access_url_id='')
@@ -633,4 +636,3 @@ class UrlManager
 		return $access_url_id;
 	}
 }
-?>

main/inc/lib/usergroup.lib.php

@@ -1,15 +1,19 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
-*	This class provides methods for the UserGroup management.
-*	Include/require it in your code to use its features.
-*	@package chamilo.library
-*/
-
+ * This class provides methods for the UserGroup management.
+ * Include/require it in your code to use its features.
+ * @package chamilo.library
+ */
+/**
+ * Code
+ */
 require_once 'model.lib.php';
 require_once api_get_path(LIBRARY_PATH).'sessionmanager.lib.php';
-
+/**
+ * Class
+ * @package chamilo.library
+ */
 class UserGroup extends Model {
 
     var $columns = array('id', 'name','description');
@@ -285,4 +289,4 @@ class UserGroup extends Model {
             }
         }
     }
-}
+}