Minor - Added PHPDoc blocks

main/admin/admin_page.class.php

@@ -1,5 +1,9 @@
 <?php
-
+/* For licensing terms, see /license.txt */
+/**
+ * Admin pages class definition
+ * @package chamilo.admin
+ */
 /**
  *
  * @license see /license.txt

main/admin/career_dashboard.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Careers dashboard
+ * @package chamilo.admin.career
+ */
+/**
+ * Code
+ */
 
 // Language files that should be included.
 $language_file = array('courses', 'index', 'admin');

main/admin/configure_extensions.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Edition of extensions configuration
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file='admin';
 $cidReset=true;

main/admin/configure_homepage.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Configure the portal homepage (manages multi-urls and languages)
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 $language_file = array('index','admin', 'accessibility');
 $cidReset = true;
 require_once '../inc/global.inc.php';

main/admin/event_controller.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * Global events controller class
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file = array('admin');
 $cidReset = true;

main/admin/index.php

@@ -1,11 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
 /**
- *	Index page of the admin tools
- *	@package chamilo.admin
+ * Index page of the admin tools
+ * @package chamilo.admin
+ */
+/**
+ * Code
  */
-
 // Language files that need to be included.
 $language_file = array('admin', 'tracking','coursebackup');
 

main/admin/ldap_form_add_users_group.php

@@ -1,24 +1,10 @@
 <?php //$id: $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2008 Dokeos SPRL
-	Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
-
-	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: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium, info@dokeos.com
-==============================================================================
-*/
+/* For licensing terms, see /license.txt */
+/**
+ * Form to add users through LDAP (deprecated?)
+ * @package chamilo.admin
+ * Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
+ */
 /**
  * This form is included by ldap_import_students.php and ldap_import_students_to_session.php
  */

main/admin/ldap_import_students.php

@@ -1,24 +1,13 @@
-<?php //$id: $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2008 Dokeos SPRL
-	Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
-
-	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: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium, info@dokeos.com
-==============================================================================
-*/
+<?php
+/* For licensing terms, see /license.txt */
+/**
+ * Script to import students from LDAP
+ * @package chamilo.admin
+ * Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
+ */
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file[]='admin';
 $language_file[]='registration';

main/admin/ldap_import_students_to_session.php

@@ -1,24 +1,13 @@
-<?php //$id: $
-/*
-==============================================================================
-	Dokeos - elearning and course management software
-
-	Copyright (c) 2008 Dokeos SPRL
-	Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
-
-	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: Dokeos, rue du Corbeau, 108, B-1030 Brussels, Belgium, info@dokeos.com
-==============================================================================
-*/
+<?php
+/* For licensing terms, see /license.txt */
+/**
+ * Edition script for sessions categories
+ * @package chamilo.admin
+ * Copyright (c) 2007 Mustapha Alouani (supervised by Michel Moreau-Belliard)
+ */
+/**
+ * Code
+ */
 // name of the language file that needs to be included
 $language_file[]='admin';
 $language_file[]='registration';

main/admin/legal_add.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Management of legal conditions
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 $language_file = array('admin','registration');
 $cidReset = true;
 require_once '../inc/global.inc.php';

main/admin/legal_list.php

@@ -1,5 +1,12 @@
 <?php
-/* For licensing terms, see /dokeos_license.txt */
+/* For licensing terms, see /license.txt */
+/**
+ * Sessions list script
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 
 $language_file = 'admin';
 $cidReset = true;

main/admin/session_category_edit.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Edition script for sessions categories
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 
 // name of the language file that needs to be included
 $language_file ='admin';

main/admin/session_category_list.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * List sessions categories
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 
 $language_file = 'admin';
 $cidReset = true;

main/admin/session_edit.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Sessions edition script
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 
 // name of the language file that needs to be included
 $language_file ='admin';

main/admin/session_list.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * List sessions in an efficient and usable way
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 $language_file = 'admin';
 $cidReset = true;
 

main/admin/style_preview.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /chamilo_license.txt */
+/**
+ * Deprecated - used to show a preview of a given stylesheet. Now replaced.
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 // @deprecated This page is not used
 
 exit;

main/admin/user_move_stats.php

@@ -1,4 +1,12 @@
 <?php
+/* For licensing terms, see /license.txt */
+/**
+ * User move scripti (to move between courses and sessions)
+ * @package chamilo.admin
+ */
+/**
+ * Code
+ */
 
 $language_file = 'admin';
 $cidReset = true;