Minor - Adapting code comments to phpdoc

main/group/group_overview.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	Main page for the group module.
  *	This script displays the general group settings,
@@ -11,10 +10,11 @@
  *	@author Patrick Cool, show group comment under the group name
  *	@author Roan Embrechts, initial self-unsubscribe code, code cleaning, virtual course support
  *	@author Bart Mollet, code cleaning, use of Display-library, list of courseAdmin-tools, use of GroupManager
- *	@package dokeos.group
+ *	@package chamilo.group
+ */
+/**
+ * INIT SECTION
  */
-
-/*	INIT SECTION */
 
 // Name of the language file that needs to be included
 $language_file = 'group';

main/inc/lib/fileDisplay.lib.php

@@ -4,13 +4,13 @@
 *	This is the file display library for Dokeos.
 *	Include/require it in your code to use its functionality.
 *
-*	@package dokeos.library
+*	@package chamilo.library
 */
-
-
+/**
+ * Code
+ */
 /*	GENERIC FUNCTIONS : FOR OLDER PHP VERSIONS */
-if ( ! function_exists('array_search') )
-{
+if ( ! function_exists('array_search') ) {
     /**
      * Searches haystack for needle and returns the key
      * if it is found in the array, FALSE otherwise.

main/inc/lib/legal.lib.php

@@ -4,10 +4,13 @@
  * Legal class
  *
  * @version 1.0
- * @package dokeos.legal
+ * @package chamilo.legal
  *
 */
-
+/**
+ * Class
+ * @package chamilo.legal
+ */
 class LegalManager {
 	private function __construct () {
 		//void
@@ -236,4 +239,4 @@ class LegalManager {
 		$rs=Database::query($sql);
 		return Database::result($rs,0,'type');
 	}
-}
+}

main/metadata/search.php

@@ -1,9 +1,10 @@
 <?php
+/* See license terms in /license.txt */
 /**
  * Chamilo metadata/search.php
  * 2005/09/20
  * @copyright 2005 rene.haentjens@UGent.be -  see metadata/md_funcs.php
- * @package dokeos.metadata
+ * @package chamilo.metadata
  */
 /**
  *	Chamilo Metadata: search Chamilo course objects via their metadata
@@ -13,17 +14,12 @@
  *   - htt=  HTML template file (same dir as script), default= 'mds_' + type.
  */
 // PRELIMS -------------------------------------------------------------------->
-
 require("md_funcs.php");
-
 getpar('TYPE', 'e.g. Mix', 'Mix');  // note: only 'Mix' is currently working
 require('md_' . strtolower(TYPE) . '.php');
-
 getpar('LFN', 'LanguageFileName', 'md_' . strtolower(TYPE));
 getpar('HTT', 'HTML Template Text filename', 'mds_' . strtolower(TYPE));
-
 getpar('DBG', 'Debug number', '0');  // set to e.g. 10000 for debuginfo
-
 $urlp =                                           '?type='. urlencode(TYPE);
 if (LFN != 'md_' . strtolower(TYPE))     $urlp .= '&lfn=' . urlencode(LFN);
 if (HTT != 'mds_' . strtolower(TYPE))    $urlp .= '&htt=' . urlencode(HTT);

plugin/search/client/client.conf.php

@@ -1,8 +1,9 @@
-<?php //$id: $
+<?php
+/* See license terms in /license.txt */
 /**
  * This script defines variables in use in the search plugin for this particular host in the client scripts
- * @package dokeos.search
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
+ * @package chamilo.search
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
  */
 /**
  * Variables

plugin/search/client/filter_user.lib.php

@@ -1,10 +1,11 @@
-<?php //$id:$
+<?php
+/* See license terms in /license.txt */
 /**
  * This script declares a set of functions that will enable authorization check
  * for a user's access to a course directory, as well as course name
  * translations for search results display.
- * @package dokeos.search
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
+ * @package chamilo.search
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
  * @uses The Dokeos database library, to access the tables using its facilities
  * @uses The Dokeos main api library to execute database queries
  */
@@ -13,7 +14,7 @@
  *
  * The function gets the course code from the course directory, then
  * checks in the course_user table if the user has access to that course.
- * @param integer User ID (inside Dokeos)
+ * @param integer User ID (inside Chamilo)
  * @param string  Course directory
  * @return boolean True if user has access, false otherwise
  */

plugin/search/index.php

@@ -1,10 +1,11 @@
-<?php //$id: $
+<?php
+/* See license terms in /license.txt */
 /**
  * This script is used as the entrance to the search plugin page. Due to its short form,
- * it can be included as a plugin in the Dokeos menu bar.
+ * it can be included as a plugin in the Chamilo menu bar.
  * No process is operated here. Just displaying the HTML form.
- * @package dokeos.search
- * @author Yannick Warnier <yannick.warnier@dokeos.com>
+ * @package chamilo.search
+ * @author Yannick Warnier <yannick.warnier@beeznest.com>
  */
 /**
  * Variables

plugin/search/plugin.php

@@ -1,11 +1,12 @@
-<?php //$id: $
+<?php
+/* See license terms in /license.txt */
 /**
  * This script is a configuration file for the search plugin.
  * You can use it as a master for other plugins.
  * These settings will be used in the administration interface for
  * plugins (Dokeos configuration settings->Plugins)
  * Make sure your read the README.txt file to understand how to use this plugin!
- * @package dokeos.plugin
+ * @package chamilo.plugin
  * @author Yannick Warnier <yannick.warnier@dokeos.com>
  */
 /**