Minor - Adapting code comments to phpdoc

main/auth/courses.php

@@ -1,12 +1,13 @@
 <?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> - Beeznest
 * @package chamilo.auth
 */
-
+/**
+ * Code
+ */
 // Names of the language file that needs to be included.
 $language_file = array ('courses', 'registration');
 

main/auth/inscription.php

@@ -1,11 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This script displays a form for registering new users.
  *	@package	 chamilo.auth
  */
-
+/**
+ * Code
+ */
 $language_file = array('registration', 'admin');
 if (!empty($_POST['language'])) { //quick hack to adapt the registration form result to the selected registration language
     $_GET['language'] = $_POST['language'];
@@ -607,4 +608,4 @@ if (!isset($_POST['username'])) {
 
 <?php
 }
-Display :: display_footer();
+Display :: display_footer();

main/auth/ldap/authldap.php

@@ -50,9 +50,10 @@
     *    @version 3.0
     *    @package chamilo.auth.ldap
 */
-
+/**
+ * Code
+ */
 require('ldap_var.inc.php');
-
 /**
  *    Check login and password with LDAP
  *    @return true when login & password both OK, false otherwise

main/auth/ldap/ldap_var.inc.php

@@ -1,29 +1,6 @@
 <?php // $Id: ldap_var.inc.php 14966 2008-04-20 23:03:11Z yannoo $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2004-2008 Dokeos SPRL
-	Copyright (c) 2003 Ghent University (UGent)
-	Copyright (c) 2001 Universite catholique de Louvain (UCL)
-	Copyright (c) Roan Embrechts (Vrije Universiteit Brussel)
-
-	For a full list of contributors, see "credits.txt".
-	The full license can be read in "license.txt".
-
-	This program is free software; you can redistribute it and/or
-	modify it under the terms of the GNU General Public License
-	as published by the Free Software Foundation; either version 2
-	of the License, or (at your option) any later version.
-
-	See the GNU General Public License for more details.
-
-	Contact address: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium
-	Mail: info@dokeos.com
-==============================================================================
-*/
+/* For licensing terms, see /license.txt */
 /**
-==============================================================================
 *	LDAP settings
 *	In the older code, there was a distinction between
 *	the teacher and student LDAP server. Later I decided not
@@ -40,9 +17,11 @@
 *	variables from the configuration.php to here as well.
 *
 *	@author Roan Embrechts
-*	@package dokeos.auth.ldap
-==============================================================================
+*	@package chamilo.auth.ldap
 */
+/**
+ * Configuration settings
+ */
 // your ldap server
 $ldap_host = api_get_setting('ldap_main_server_address');
 // your ldap server's port number
@@ -65,4 +44,3 @@ $ldap_rdn = api_get_setting('ldap_authentication_login');
 $ldap_pass = api_get_setting('ldap_authentication_password');
 
 $ldap_pass_placeholder = "PLACEHOLDER";
-?>

main/auth/ldap/login.php

@@ -1,54 +1,24 @@
 <?php // $Id: login.php 22201 2009-07-17 19:57:03Z cfasanando $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2004 Dokeos SPRL
-	Copyright (c) 2003 Ghent University (UGent)
-	Copyright (c) 2001 Universite catholique de Louvain (UCL)
-	Copyright (c) Roan Embrechts
-
-	For a full list of contributors, see "credits.txt".
-	The full license can be read in "license.txt".
-
-	This program is free software; you can redistribute it and/or
-	modify it under the terms of the GNU General Public License
-	as published by the Free Software Foundation; either version 2
-	of the License, or (at your option) any later version.
-
-	See the GNU General Public License for more details.
-
-	Contact address: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium
-	Mail: info@dokeos.com
-==============================================================================
-*/
+/* For licensing terms, see /license.txt */
 /**
-==============================================================================
-*	Users trying to login, who already exist in the Dokeos database
-*	and have ldap as authentication type, get verified here.
-*
+*	Users trying to login, who already exist in the Chamilo database
+*	and have ldap as authentication type get verified here.
 *	@author Roan Embrechts
-*	@package dokeos.auth.ldap
-==============================================================================
+*	@package chamilo.auth.ldap
 */
-
-	/*
-		An external authentification module
-		needs to set
-		- $loginFailed
-		- $uidReset
-		- $_user['user_id']
-		- register the $_user['user_id'] in the session
-		As the LDAP code shows, this is not as difficult as you might think.
-	*/
-	/*
-	===============================================
-		LDAP authentification module
-		this calls the loginWithLdap function
-		from the LDAP library, and sets a few
-		variables based on the result.
-	===============================================
-	*/
+/**
+ * An external authentification module needs to set
+ * - $loginFailed
+ * - $uidReset
+ * - $_user['user_id']
+ * - register the $_user['user_id'] in the session
+ *
+ * As the LDAP code shows, this is not as difficult as you might think.
+ * LDAP authentification module
+ * this calls the loginWithLdap function
+ * from the LDAP library, and sets a few
+ * variables based on the result.
+ */
 //require_once('../../inc/global.inc.php'); - this script should be loaded by the /index.php script anyway, so global is already loaded
 require_once('authldap.php');
 
@@ -69,4 +39,4 @@ else
 	unset($_user['user_id']);
 	$uidReset = false;
 }
-?>
+?>

main/auth/ldap/newUser.php

@@ -1,44 +1,16 @@
 <?php # $Id: newUser.php 14965 2008-04-20 23:01:17Z yannoo $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2004 Dokeos SPRL
-	Copyright (c) 2003 Ghent University (UGent)
-	Copyright (c) 2001 Universite catholique de Louvain (UCL)
-	Copyright (c) Roan Embrechts
-
-	For a full list of contributors, see "credits.txt".
-	The full license can be read in "license.txt".
-
-	This program is free software; you can redistribute it and/or
-	modify it under the terms of the GNU General Public License
-	as published by the Free Software Foundation; either version 2
-	of the License, or (at your option) any later version.
-
-	See the GNU General Public License for more details.
-
-	Contact address: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium
-	Mail: info@dokeos.com
-==============================================================================
-*/
+/* For licensing terms, see /license.txt */
 /**
-==============================================================================
-*	Users trying to login, who do not yet exist in the Dokeos database,
-*	can be added by this script which tries to retrieve ldap information about
-*   them.
-*
-*	@author Roan Embrechts
-*	@package dokeos.auth.ldap
-==============================================================================
+* Users trying to login, who do not yet exist in the Chamilo database,
+* can be added by this script which tries to retrieve ldap information 
+* about them.
+* @author Roan Embrechts
+* @package chamilo.auth.ldap
 */
-
-/*
-==================================================
-	when a user does not exist yet in dokeos,
-	but he or she does exist in the LDAP,
-	we add him to the dokeos database
-==================================================
+/**
+ * when a user does not exist yet in dokeos,
+ * but he or she does exist in the LDAP,
+ * we add him to the dokeos database
 */
 //require_once('../../inc/global.inc.php'); - this script should be loaded by the /index.php script anyway, so global is already loaded
 require_once('authldap.php');
@@ -65,4 +37,4 @@ else
 	unset($_user['user_id']);
 	$uidReset = false;
 }
-?>
+?>

main/auth/lostPassword.php

@@ -14,6 +14,9 @@
 *
 *	@package chamilo.auth
 */
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file = 'registration';
 
@@ -98,4 +101,4 @@ if (isset ($_GET['reset']) && isset ($_GET['id'])) {
 		$form->display();
 	}
 }
-Display::display_footer();
+Display::display_footer();

main/auth/lost_password.lib.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Code
+ * @package chamilo.auth
+ */
 /**
  * @deprecated by Ivan Tcholakov, 09-OCT-2009.
  * Get email headers
@@ -22,8 +25,7 @@ function get_email_headers() {
 */
 
 /**
- * Enter description here...
- *
+ * Get list of user accounts with a reset link for each
  * @param unknown_type $user
  * @param boolean $reset
  * @param boolean $by_username

main/auth/my_progress.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Reporting page on the user's own progress
+ * @package chamilo.tracking
+ */
+/**
+ * Code
+ */
 
 // name of the language file that needs to be included
 $language_file = array('registration', 'tracking', 'exercice', 'admin');
@@ -60,4 +67,4 @@ if (!empty($user_progress)) {
     Display::display_warning_message(get_lang('NoDataAvailable'));
 }
     
-Display :: display_footer();
+Display :: display_footer();

main/auth/openid/login.php

@@ -1,4 +1,5 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * OpenID login method
  *
@@ -6,6 +7,7 @@
  * URL that can confirm the identity of a person, thus avoiding the spread
  * use of password transmissions over non-secure lines (for Dokeos, it is a
  * good way of avoiding password theft)
+ * @package chamilo.auth.openid
  */
 /**
  * Initialisation
@@ -464,4 +466,4 @@ function openid_http_request($url, $headers = array(), $method = 'GET', $data =
 
   $result->code = $code;
   return $result;
-}
+}

main/auth/openid/openid.conf.php

@@ -1,9 +1,14 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * Configuration file for openID authentication
+ * @package chamilo.auth.openid
+ */
+/**
+ * Code
  */
 $langMainInfo = 'You may login to this site using an OpenID. You may add your OpenId URLs below, and also see a list of any OpenIDs which have already been added.';
 $langMainInfoDetail = '<p>OpenID is a secure way to use one user ID and password to log in to many web sites without special software, giving the same password to each site, or losing control over which information is shared with each site that you visit.</p>';
 $langMainInfoDetail .= '<p>Users can create accounts using their OpenID, assign one or more OpenIDs to an existing account, and log in using an OpenID. This lowers the barrier to registration, which is good for the site, and offers convenience and security to the users. Logging in via OpenID is far more secure than cross-site logins using drupal.module.</p>';
 $langMainInfoDetail .= '<p>More information on OpenID is available at <a href="http://openid.net">OpenID.net</a></p>';
-?>
+?>

main/auth/openid/openid.lib.php

@@ -1,9 +1,13 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * OpenID utility functions. Taken from Drupal 6 code (from dries)
  * @file openid.lib.php
+ * @package chamilo.auth.openid
+ */
+/**
+ * Code
  */
-
 // Diffie-Hellman Key Exchange Default Value.
 define('OPENID_DH_DEFAULT_MOD', '155172898181473697471232257763715539915724801'.
        '966915404479707795314057629378541917580651227423698188993727816152646631'.

main/auth/openid/whatis.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * OpenID 
+ * @package chamilo.auth.openid
+ */
+/**
+ * Code
+ */
 require('../../inc/global.inc.php');
 Display::display_header('OpenID', NULL);
 ?>
@@ -16,4 +24,4 @@ Display::display_header('OpenID', NULL);
 </p>
 <?php
 Display::display_footer();
-?>
+?>

main/auth/openid/xrds.lib.php

@@ -1,6 +1,11 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * Parsing library for OpenID
+ * @package chamilo.auth.openid
+ */
+/**
+ * Code
  */
 // Global variables to track parsing state
 $xrds_open_elements = array();
@@ -77,4 +82,4 @@ function _xrds_strip_namespace($name) {
   }
 
   return $name;
-}
+}

main/auth/profile.php

@@ -8,6 +8,9 @@
 *
 * @package chamilo.auth
 */
+/**
+ * Code
+ */
 
 /*  Init section  */
 
@@ -855,4 +858,4 @@ if (api_get_setting('allow_social_tool') == 'true') {
 	echo '</div>';
 	$form->display();
 }
-Display :: display_footer();
+Display :: display_footer();

main/auth/sso/sso.class.php

@@ -1,4 +1,5 @@
 <?php
+/* For licensing terms, see /license.txt */
 /**
  * This file contains the necessary elements to implement a Single Sign On 
  * mechanism with an arbitrary external web application (given some light 
@@ -6,6 +7,7 @@
  * To develop a new authentication mechanism, please extend this class and
  * overwrite its method, then modify the corresponding calling code in 
  * main/inc/local.inc.php
+ * @package chamilo.auth.sso
  */
 /**
  * The SSO class allows for management or remote Single Sign On resources

main/chat/chat.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Chat tool
+ * @package chamilo.chat
+ */
+/**
+ * Code
+ */
 
 $language_file = array('chat');
 

main/chat/chat_chat.php

@@ -7,6 +7,9 @@
  *	@author Olivier Brouckaert
  *	@package chamilo.chat
  */
+/**
+ * Code
+ */
 
 define('FRAME', 'chat');
 

main/chat/chat_hidden.php

@@ -7,6 +7,9 @@
  *	@author Olivier Brouckaert
  *	@package chamilo.chat
  */
+/**
+ * Code
+ */
 
 define('FRAME', 'hidden');
 

main/chat/chat_message.php

@@ -7,6 +7,9 @@
  *	@author Olivier Brouckaert
  *	@package chamilo.chat
  */
+/**
+ * Code
+ */
 
 /*		INIT SECTION */
 
@@ -289,4 +292,4 @@ if (!empty($course) && !empty($_user['user_id'])) {
     </form>
 <?php
 }
-require 'footer_frame.inc.php';
+require 'footer_frame.inc.php';

main/chat/chat_whoisonline.php

@@ -1,13 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	Shows the list of connected users
  *
  *	@author Olivier Brouckaert
  *	@package chamilo.chat
  */
-
+/**
+ * Code
+ */
 define('FRAME', 'online');
 $language_file = array('chat');
 

main/chat/header_frame.inc.php

@@ -8,6 +8,9 @@
  *  @modified by Denes Nagy
  *	@package chamilo.chat
  */
+/**
+ * Code
+ */
 
 if (!defined('FRAME')) {
 	exit();
@@ -109,4 +112,4 @@ function send_message(evenement){
 </script>
 
 </head>
-<body <?php echo $bodyXtra; ?> >
+<body <?php echo $bodyXtra; ?> >

main/create_course/add_course.php

@@ -11,6 +11,9 @@
  * "Course validation" feature, technical adaptation for Chamilo 1.8.8:
  * @author Ivan Tcholakov <ivantcholakov@gmail.com>
  */
+/**
+ * Code
+ */
 
 // Name of the language file that needs to be included.
 $language_file = 'create_course';

main/document/create_audio.php

@@ -10,6 +10,9 @@
  * @since 8/January/2011
  * TODO:clean all file
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 $language_file = array('document');
@@ -501,4 +504,4 @@ function downloadMP3_pediaphone($filepath, $dir){
 	}	
 }
 
-?>
+?>

main/document/create_document.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file allows creating new html documents with an online WYSIWYG html editor.
  *
  *	@package chamilo.document
  */
-
+/**
+ * Code
+ */
 /*	INIT SECTION */
 
 // Name of the language file that needs to be included
@@ -682,4 +683,4 @@ if ($form->validate()) {
 	echo '</div>';
 	$form->display();
 	Display :: display_footer();
-}
+}

main/document/create_draw.php

@@ -6,9 +6,12 @@
  *
  *	@package chamilo.document
  *
- * @author Juan Carlos Ra<EFBFBD>a Trabado
+ * @author Juan Carlos Raña Trabado
  * @since 25/september/2010
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 
@@ -160,4 +163,4 @@ if (api_browser_support('svg')){
 	Display::display_error_message(get_lang('BrowserDontSupportsSVG'));
 }
 
-Display :: display_footer();
+Display :: display_footer();

main/document/create_paint.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file allows creating audio files from a text.
  *
@@ -8,8 +7,11 @@
  *
  * @author Juan Carlos Raña Trabado
  * @since 30/January/2011
- * TODO:clean all file
+ * @todo clean all file
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 $language_file = array('document');
@@ -152,4 +154,4 @@ $target=$target_path;
 $locktarget="true";
 $locktitle="false";
 echo '<iframe style=\'height: 600px; width: 100%;\' scrolling=\'no\' frameborder=\'0\' src=\'http://pixlr.com/editor/?title='.$title.'&amp;image='.$image.'&amp;loc='.$loc.'&amp;referrer='.$referrer.'&amp;target='.$target.'&amp;exit='.$exit_path.'&amp;locktarget='.$locktarget.'&amp;locktitle='.$locktitle.'\'>';
-echo '</iframe>';
+echo '</iframe>';

main/document/document.inc.php

@@ -1,8 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
-/*	EXTRA FUNCTIONS FOR DOCUMENTS TOOL */
-
+/**
+ * EXTRA FUNCTIONS FOR DOCUMENTS TOOL
+ * @package chamilo.document
+ */
 /**
  * Builds the form thats enables the user to
  * select a directory to browse/upload in
@@ -848,4 +849,4 @@ function is_browser_viewable($file_extension) {
             return api_browser_support('svg');
     }
     return $result;
-}
+}

main/document/document.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * Homepage script for the documents tool
  *
@@ -29,6 +28,9 @@
  * @package chamilo.document
  */
 
+/**
+ * Code
+ */
 /*	INIT SECTION */
 
 // Language files that need to be included
@@ -1179,4 +1181,4 @@ if (!empty($table_footer)) {
 }
 
 // Footer
-Display::display_footer();
+Display::display_footer();

main/document/document_slideshow.inc.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This is a plugin for the documents tool. It looks for .jpg, .jpeg, .gif, .png
  *	files (since these are the files that can be viewed in a browser) and creates
@@ -19,15 +18,13 @@
  *	@author Roan Embrechts, minor cleanup
  *	@package chamilo.document
  */
-
-/*
-	General code that belongs in document.php
-
-	This code should indeed go in documents.php but since document.php is already a really ugly file with
-	too much things in one file , I decided to put the code for document.php here and to include this
-	file into document.php
-*/
-
+/**
+ *	General code that belongs in document.php
+ *
+ *	This code should indeed go in documents.php but since document.php is already a really ugly file with
+ *	too much things in one file , I decided to put the code for document.php here and to include this
+ *	file into document.php
+ */
 $accepted_extensions = array('.jpg', '.jpeg', '.gif', '.png');
 
 // Resetting the images of the slideshow = destroying the slideshow

main/document/download.php

@@ -1,20 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file is responsible for  passing requested documents to the browser.
  *
  *	@package chamilo.document
  */
-
-/*	FUNCTIONS */
-
-/* file_html_dynamic_parsing removed */
-
-/* Other functions updated and moved to lib/document.lib.php */
-
-/*	MAIN CODE */
-
+/**
+ * Code
+ * Many functions updated and moved to lib/document.lib.php
+ */
 session_cache_limiter('none');
 
 require_once '../inc/global.inc.php';
@@ -84,4 +78,4 @@ if (Security::check_abs_path($sys_course_path.$doc_url, $sys_course_path.'/')) {
     }    
     DocumentManager::file_send_for_download($full_file_name);
 }
-exit;
+exit;

main/document/downloadfolder.inc.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	Functions and main code for the download folder feature
  *
  *	@package chamilo.document
  */
-
+/**
+ * Code
+ */
 set_time_limit(0);
 
 $document_data = DocumentManager::get_document_data_by_id($_GET['id'], api_get_course_id());

main/document/edit_document.php

@@ -24,6 +24,9 @@
  * @todo improve script structure (FormValidator is used to display form, but
  * not for validation at the moment)
  */
+/**
+ * Code
+ */
 
 // Name of the language file that needs to be included
 $language_file = array('document', 'gradebook');
@@ -575,4 +578,4 @@ function show_return($document_id, $path, $call_from_tool='', $slide_id=0, $is_c
 		echo '<a href="document.php?action=exit_slideshow&id='.$parent_id.'">'.Display::return_icon('back.png', get_lang('BackTo').' '.get_lang('DocumentsOverview'),'','32').'</a>';
 	}
 	echo '</div>';
-}
+}

main/document/edit_draw.php

@@ -9,6 +9,9 @@
  * @author Juan Carlos Ra<EFBFBD>a Trabado
  * @since 25/september/2010
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 
@@ -120,4 +123,4 @@ if (api_browser_support('svg')) {
 } else {	
 	Display::display_error_message(get_lang('BrowserDontSupportsSVG'));
 }
-Display::display_footer();
+Display::display_footer();

main/document/edit_paint.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file allows creating new svg and png documents with an online editor.
  *
@@ -10,6 +9,9 @@
  * @author Juan Carlos Ra<EFBFBD>a Trabado
  * @since 30/january/2011
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 
@@ -182,4 +184,4 @@ $pixlr_url = 'http://pixlr.com/editor/?title='.$title.'&amp;image='.$image.'&amp
 //make frame an send image
 echo '<iframe style="height: 600px; width: 100%;" scrolling="no" frameborder="0" src="'.$pixlr_url.'">';
 echo '</iframe>';
-Display::display_footer();
+Display::display_footer();

main/document/exit_pixlr.php

@@ -9,6 +9,9 @@
  * @author Juan Carlos Ra<EFBFBD>a Trabado
  * @since 30/january/2011
 */
+/**
+ * Code
+ */
 
 require_once '../inc/global.inc.php';
 api_protect_course_script();
@@ -33,4 +36,4 @@ else{
 	$location=api_get_path(WEB_CODE_PATH).'document/document.php?id='.Security::remove_XSS($_SESSION['exit_pixlr']);
 	echo '<script>window.parent.location.href="'.$location.'"</script>';
 	unset($_SESSION['exit_pixlr']);
-}
+}

main/document/footerpage.php

@@ -1,11 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	@package chamilo.document
  *	TODO: There is no indication that this file us used for something.
  */
-
+/**
+ * Code
+ */
 require_once '../inc/global.inc.php';
 
 $my_style = api_get_visual_theme();

main/document/headerpage.php

@@ -4,6 +4,9 @@
 /**
  *	@package chamilo.document
  */
+/**
+ * Code
+ */
 
 // Name of the language file that needs to be included
 exit;
@@ -35,4 +38,4 @@ $file_url_web = api_get_path(WEB_COURSE_PATH).$_course['path'].'/document'.$head
 echo "<h1>";
 echo '<a href="'.$file_url_web.'" target="blank">'.get_lang('_cut_paste_link').'</a></div>';
 
-echo "</h1>";
+echo "</h1>";

main/document/quota.php

@@ -9,6 +9,9 @@
  *	@author Roan Embrechts
  *	@package chamilo.document
  */
+/**
+ * Code
+ */
 
 // Name of the language file that needs to be included
 exit;

main/document/record_audio.php

@@ -9,6 +9,9 @@
  * @author Juan Carlos Raña Trabado herodoto@telefonica.net
  * @since 5/mar/2011
 */
+/**
+ * Code
+ */
 
 /*	INIT SECTION */
 
@@ -210,4 +213,4 @@ if ($array_browser[0]=="Internet Explorer") {
 	echo '</form>';
 }
 echo '</div>';
-Display :: display_footer();
+Display :: display_footer();

main/document/save_pixlr.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file allows creating new svg and png documents with an online editor.
  *
@@ -9,7 +8,9 @@
  * @author Juan Carlos Ra<EFBFBD>a Trabado
  * @since 30/january/2011
 */
-
+/**
+ * Code
+ */
 require_once '../inc/global.inc.php';
 require_once api_get_path(LIBRARY_PATH).'fileUpload.lib.php';
 require_once api_get_path(LIBRARY_PATH).'document.lib.php';
@@ -141,4 +142,4 @@ else{
 	$location=api_get_path(WEB_CODE_PATH).'document/document.php?curdirpath='.Security::remove_XSS($_SESSION['exit_pixlr']);
 	echo '<script>window.parent.location.href="'.$location.'"</script>';
 	unset($_SESSION['exit_pixlr']);
-}
+}

main/document/showinframes.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	This file will show documents in a separate frame.
  *	We don't like frames, but it was the best of two bad things.
@@ -22,9 +21,9 @@
  *	@author Roan Embrechts (roan.embrechts@vub.ac.be)
  *	@package chamilo.document
  */
-
-/*   INITIALIZATION */
-
+/**
+ * INITIALIZATION
+ */
 $language_file[] = 'document';
 require_once '../inc/global.inc.php';
 require_once api_get_path(LIBRARY_PATH).'document.lib.php';
@@ -109,7 +108,9 @@ $this_section = SECTION_COURSES;
 $_SESSION['whereami'] = 'document/view';
 $nameTools = get_lang('Documents');
 
-/*	Main section */
+/**
+ * Main code section
+ */
 header('Expires: Wed, 01 Jan 1990 00:00:00 GMT');
 //header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
 header('Last-Modified: Wed, 01 Jan 2100 00:00:00 GMT');
@@ -202,4 +203,4 @@ if ($pathinfo['extension']=='wav' && api_get_setting('enable_nanogong') == 'true
 else{
 	echo '<iframe border="0" frameborder="0" scrolling="no" style="width:100%;"  id="mainFrame" name="mainFrame" src="'.$file_url_web.'?'.api_get_cidreq().'&amp;rand='.mt_rand(1, 10000).'"></iframe>';
 }
-Display::display_footer();
+Display::display_footer();

main/document/showinframesmin.php

@@ -1,12 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- *	@author Juan Carlos Ra<EFBFBD>a Trabado (herodoto@telefonica.net)
+ *	@author Juan Carlos Raña Trabado (herodoto@telefonica.net)
  *  
  *	@package chamilo.document
  */
-
+/**
+ * Code
+ */
 /*   INITIALIZATION */
 
 $language_file[] = 'document';
@@ -159,4 +160,4 @@ if ($pathinfo['extension']=='wav' && api_get_setting('enable_nanogong') == 'true
 	if ($pathinfo['extension']=='swf'){ $width='83%'; $height='83%';} else {$width='100%'; $height='';}
 	
 	echo '<iframe border="0" frameborder="0" scrolling="no" style="width:'.$width.'; height:'.$height.';background-color:#ffffff;" id="mainFrame" name="mainFrame" src="'.$file_url_web.'?'.api_get_cidreq().'&amp;rand='.mt_rand(1, 10000).'"></iframe>';
-}
+}

main/document/slideshow.php

@@ -1,13 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- *  @author Julio Montoya Lots of improvements, cleaning, adding security
- *	@author Patrick Cool patrick.cool@UGent.be Ghent University Mai 2004
- *	@author Juan Carlos Raña Trabado herodoto@telefonica.net	January 2008
- *	@package chamilo.document
+ * @author Patrick Cool patrick.cool@UGent.be Ghent University Mai 2004
+ * @author Julio Montoya Lots of improvements, cleaning, adding security
+ * @author Juan Carlos Raña Trabado herodoto@telefonica.net	January 2008
+ * @package chamilo.document
+ */
+/**
+ * Code
  */
-
 // Language files that need to be included
 $language_file = array('slideshow', 'document');
 
@@ -307,4 +308,4 @@ if ($slide_id != 'all') {
 	}
 }
 
-Display :: display_footer();
+Display :: display_footer();

main/document/slideshowoptions.php

@@ -1,38 +1,29 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  *	@author Patrick Cool
  *	@package chamilo.document
+ * @author Patrick Cool, patrick.cool@UGent.be, Ghent University, May 2004, http://icto.UGent.be
+ * Please bear in mind that this is only an beta release.
+ * I wrote this quite quick and didn't think too much about it in advance.
+ * It is not perfect at all but it is workable and usefull (I think)
+ * Do not consider this as a powerpoint replacement, although it has
+ * the same starting point.
+ * @description
+ *	This is a plugin for the documents tool. It looks for .jpg, .jpeg, .gif, .png
+ * 	files (since these are the files that can be viewed in a browser) and creates
+ *	a slideshow with it by allowing to go to the next/previous image.
+ *	You can also have a quick overview (thumbnail view) of all the images in
+ *	that particular folder.
+ *	Maybe it is important to notice that each slideshow is folder based. Only
+ *	the images of the chosen folder are shown.
+ *
+ *	On this page the options of the slideshow can be set: maintain the original file
+ *	or resize the file to a given width.
+ */
+/**
+ * Code
  */
-
-/*
-Developped by Patrick Cool
-patrick.cool@UGent.be
-Ghent University
-May 2004
-http://icto.UGent.be
-
-Please bear in mind that this is only an beta release.
-I wrote this quite quick and didn't think too much about it in advance.
-It is not perfect at all but it is workable and usefull (I think)
-Do not consider this as a powerpoint replacement, although it has
-the same starting point.
-*/
-
-/*
-Description:
-	This is a plugin for the documents tool. It looks for .jpg, .jpeg, .gif, .png
-	files (since these are the files that can be viewed in a browser) and creates
-	a slideshow with it by allowing to go to the next/previous image.
-	You can also have a quick overview (thumbnail view) of all the images in
-	that particular folder.
-	Maybe it is important to notice that each slideshow is folder based. Only
-	the images of the chosen folder are shown.
-
-	On this page the options of the slideshow can be set: maintain the original file
-	or resize the file to a given width.
-*/
 
 // Language files that need to be included
 $language_file = array('slideshow', 'document');

main/document/upload.php

@@ -1,6 +1,5 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
  * Main script for the documents tool
  *
@@ -32,7 +31,9 @@
  *
  * @package chamilo.document
  */
-
+/**
+ * Code
+ */
 // Name of the language file that needs to be included
 $language_file = array('document','gradebook');
 
@@ -300,4 +301,4 @@ $headers = array(get_lang('Send') , get_lang('Send').' ('.get_lang('Simple').')'
 echo Display::tabs($headers, array($multiple_form, $simple_form ),'tabs');
 
 // Footer
-Display::display_footer();
+Display::display_footer();

main/messages/download.php

@@ -8,8 +8,9 @@
 *
 *	@package chamilo.messages
 */
-
-/*		MAIN CODE	*/
+/**
+ * MAIN CODE
+ */
 
 session_cache_limiter('public');
 
@@ -90,4 +91,4 @@ if (Security::check_abs_path($full_file_name, $path_user_info['dir'].'message_at
     event_download($file_url);
     DocumentManager::file_send_for_download($full_file_name,TRUE, $title);
 }
-exit;
+exit;

main/messages/inbox.php

@@ -3,7 +3,9 @@
 /**
 *	@package chamilo.messages
 */
-
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file = array('registration','messages','userInfo');
 $cidReset = true;
@@ -181,4 +183,4 @@ echo '<div id="social-content">';
 	echo '</div>';	
 echo '</div>';
 
-Display::display_footer();
+Display::display_footer();

main/messages/index.php

@@ -3,7 +3,9 @@
 /**
 *	@package chamilo.messages
 */
-
+/**
+ * Code
+ */
 require_once '../inc/global.inc.php';
 if (api_get_setting('allow_social_tool')=='true' &&  api_get_setting('allow_message_tool')=='true') {
 	header('Location:inbox.php?f=social');	
@@ -11,4 +13,4 @@ if (api_get_setting('allow_social_tool')=='true' &&  api_get_setting('allow_mess
 	header('Location:inbox.php');
 }
 exit;
-?>
+?>

main/messages/outbox.php

@@ -3,7 +3,9 @@
 /**
 *	@package chamilo.messages
 */
-
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file = array('registration','messages','userInfo');
 $cidReset=true;
@@ -179,4 +181,4 @@ echo '<div id="social-content">';
 echo '</div>';
 
 /*		FOOTER */
-Display::display_footer();
+Display::display_footer();

main/messages/send_message.php

@@ -3,7 +3,9 @@
 /**
 *	@package chamilo.messages
 */
-
+/**
+ * Code
+ */
 $language_file = array('registration','messages','userInfo','admin');
 $cidReset=true;
 require_once '../inc/global.inc.php';
@@ -78,4 +80,4 @@ if ($panel_id==4 && !empty($content_message)) {
 } elseif ($panel_id==5 && !empty($subject_message) ) {
 	SocialManager::send_invitation_friend_user($user_id,$subject_message,$content_message);
 }
-?>
+?>

main/messages/send_message_to_userfriend.inc.php

@@ -3,6 +3,9 @@
 /**
 *	@package chamilo.messages
 */
+/**
+ * Code
+ */
 $language_file = array('registration','messages','userInfo','admin');
 $cidReset = true;
 require_once '../inc/global.inc.php';
@@ -57,4 +60,4 @@ if (api_get_setting('allow_message_tool')=='true') {
 <?php			}
 			} ?>
     </dl>
-</div>
+</div>

main/messages/view_message.php

@@ -3,7 +3,9 @@
 /**
 *	@package chamilo.messages
 */
-
+/**
+ * Code
+ */
 $language_file = array('registration','messages','userInfo');
 $cidReset= true;
 require_once '../inc/global.inc.php';
@@ -85,4 +87,4 @@ echo '<div id="social-content">';
 echo '</div>';
 
 /*		FOOTER */
-Display::display_footer();
+Display::display_footer();

main/user/subscribe_user.php

@@ -6,6 +6,9 @@
 *	to their course.
 *	@package chamilo.user
 */
+/**
+ * Code
+ */
 
 /*			INIT SECTION		*/
 // name of the language file that needs to be included
@@ -771,4 +774,4 @@ function display_extra_profile_fields_filter()
 	echo   '<select name="subscribe_user_filter_value" id="subscribe_user_filter_value">'.$return.'</select>';
 	echo   '<button type="submit" name="submit_filter" id="submit_filter" value="" class="search">'.get_lang('Filter').'</button>';
 	echo '</form>';
-}
+}

main/user/user_add.php

@@ -3,6 +3,9 @@
 /**
 *	@package chamilo.user
 */
+/**
+ * Code
+ */
 
 /* INIT	*/
 
@@ -366,4 +369,4 @@ else
     echo "<p>".get_lang('IfYouWantToAddManyUsers')."</p>";
 }
 
-Display::display_footer();
+Display::display_footer();