Minor - Adapting code comments to phpdoc

main/exercice/exercise_result.class.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
 /**
-*	ExerciseResult class: This class allows to instantiate an object of type ExerciseResult
-*	which allows you to export exercises results in multiple presentation forms
-*	@package chamilo.exercise
-* 	@author Yannick Warnier
-* 	@version $Id: $
-*/
+ * ExerciseResult class: This class allows to instantiate an object 
+ * of type ExerciseResult
+ * which allows you to export exercises results in multiple presentation forms
+ * @package chamilo.exercise
+ * @author Yannick Warnier
+ * @version $Id: $
+ */
 /**
  * Code
  */

main/inc/lib/blog.lib.php

@@ -616,8 +616,7 @@ class Blog {
 	/**
 	 * Get personal task list
 	 * @author Toon Keppens
-	 *
-	 * @return Returns an unsorted list (<ul>) with the users' tasks
+	 * @return Returns an unsorted list (<ul></ul>) with the users' tasks
 	 */
 	public static function get_personal_task_list () {
 		global $_user;

main/inc/lib/course_request.lib.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * Course request manager
  * @package chamilo.library
@@ -11,7 +10,9 @@
  *
  * @author Ivan Tcholakov <ivantcholakov@gmail.com> (technical adaptation for Chamilo 1.8.8), 2010
  */
-
+/**
+ * Code
+ */
 define(COURSE_REQUEST_PENDING,  0);
 define(COURSE_REQUEST_ACCEPTED, 1);
 define(COURSE_REQUEST_REJECTED, 2);

main/inc/lib/debug.lib.php

@@ -14,7 +14,7 @@ class Debug {
 	/**
 	 * This function displays the contend of a variable, array or object in a nicely formatted way.
 	 * @param	Mixed	A variable, array or object
-	 * @return 	void	Prints <pre> HTML block to output
+	 * @return 	void	Prints \<pre\> HTML block to output
 	 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 	 * @version November 2006
 	 */

main/inc/lib/geometry.lib.php

@@ -1,8 +1,7 @@
 <?php
 /* For licensing terms, see /license.txt */
 /**
- *
- * @author: Arnaud Ligot (CBlue SPRL) <arnaud@cblue.be>
+ * @author Arnaud Ligot (CBlue SPRL) <arnaud@cblue.be>
  * @package chamilo.include.geometry
  */
 /**
@@ -11,10 +10,8 @@
 DEFINE('DEBUG', false);
 /**
  * poly_init -    build the array which will store the image of the polygone
- *
  * @param max[x]    X resolution
  * @param max[y]    Y resolution
- *
  * @returns an array such as: for all i in [0..max[x][ : for all j in [0..max[y][ : array[i][j] = FALSE
  * @package chamilo.include.geometry
  */

main/inc/lib/import.lib.php

@@ -1,12 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * This class provides some functions which can be used when importing data from
  * external files into Chamilo.
  * @package	 chamilo.library
  */
-
+/**
+ * Class
+ * @package	 chamilo.library
+ */
 class Import {
 
 	/**

main/inc/lib/model.lib.php

@@ -1,12 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
 *	This class provides basic methods to implement a CRUD for a new table in the database see examples in: career.lib.php and promotion.lib.php
 *	Include/require it in your code to use its features.
 *	@package chamilo.library
 */
-
+/**
+ * Class
+ * @package chamilo.library
+ */
 class Model {
     
     var $table;
@@ -142,4 +144,4 @@ class Model {
         }
         return false;
     }
-}
+}

main/inc/lib/pdf.lib.php

@@ -37,7 +37,7 @@ class PDF {
      * @param   mixed   could be an html file path or an array with paths example: /var/www/myfile.html or array('/myfile.html','myotherfile.html') or even an indexed array with both 'title' and 'path' indexes for each element like array(0=>array('title'=>'Hello','path'=>'file.html'),1=>array('title'=>'Bye','path'=>'file2.html'));
      * @param   string  pdf name   
      * @param   string  course code (if you are using html that are located in the document tool you must provide this) 
-     * @return  
+     * @return void
      */    
     public function html_to_pdf($html_file_array, $pdf_name = '', $course_code = null, $print_title = false) {
         

main/inc/lib/search/DokeosIndexer.class.php

@@ -1,11 +1,17 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * @package chamilo.include.search
+ */
+/**
+ * code
+ */
 require_once dirname(__FILE__) . '/../../global.inc.php';
 include_once 'xapian/XapianIndexer.class.php';
 
 /**
  * Class wrapper
+ * @package chamilo.include.search
  */
 class DokeosIndexer extends XapianIndexer {
 
@@ -85,5 +91,3 @@ if (!function_exists('trim_value')) {
 		$value = trim($value);
 	}
 }
-
-?>

main/inc/lib/search/DokeosQuery.php

@@ -2,7 +2,7 @@
 /* For licensing terms, see /dokeos_license.txt */
 /*
  * Script defining generic functions against a search engine api. Just only if one day the search engine changes
- * @package: chamilo.include.search
+ * @package chamilo.include.search
  */
 /**
  * Code

main/inc/lib/search/IndexableChunk.class.php

@@ -93,6 +93,7 @@ abstract class _IndexableChunk
 
 /**
  * Extension of the _IndexableChunk class to make IndexableChunk extensible.
+ * @package chamilo.include.search
  */
 class IndexableChunk extends _IndexableChunk
 {
@@ -111,5 +112,3 @@ class IndexableChunk extends _IndexableChunk
   }
 
 }
-
-?>

main/inc/lib/search/xapian/XapianIndexer.class.php

@@ -1,7 +1,6 @@
 <?php
 /* For licensing terms, see /license.txt */
 /**
- *
  * @package chamilo.include.search
  */
 /**
@@ -12,6 +11,7 @@ require_once dirname(__FILE__) . '/../IndexableChunk.class.php';
 
 /**
  * Abstract helper class
+ * @package chamilo.include.search
  */
 abstract class XapianIndexer {
     /* XapianWritableDatabase */

main/inc/lib/sortabletable.class.php

@@ -761,7 +761,7 @@ class SortableTable extends HTML_Table {
 
 	/**
 	 * Define a list of additional parameters to use in the generated URLs
-	 * @example $parameters['action'] = 'test'; will be convert in <input type="hidden" name="action" value="test">
+	 * <code>$parameters['action'] = 'test'; will be convert in <input type="hidden" name="action" value="test"></code>
 	 * @param array $parameters
 	 */
 	public function set_additional_parameters ($parameters) {

main/inc/lib/text.lib.php

@@ -420,9 +420,9 @@ function make_clickable($string) {
  * @desc This function does some parsing on the text that gets inputted. This parsing can be of any kind
  *       LaTeX notation, Word Censoring, Glossary Terminology (extension will available soon), Musical Notations, ...
  *       The inspiration for this filter function came from Moodle an phpBB who both use a similar approach.
+ * <code>[tex]\sqrt(2)[/tex]</code>
  * @param $input string. some text
  * @return $output string. some text that contains the parsed elements.
- * @example [tex]\sqrt(2)[/tex]
  * @author Patrick Cool <patrick.cool@UGent.be>
  * @version March 2OO6
  */

main/inc/lib/upload.xajax.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * @chamilo.library
+ * @package chamilo.library
  */
 /**
  * Code