Minor - Adapting code comments to phpdoc

main/gradebook/exercise_jump.php

@@ -7,6 +7,10 @@
  * variables.
  * Most code here is ripped from /main/course_home/course_home.php
  * @author Bert Steppé
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
  */
 
 require_once '../inc/global.inc.php';

main/gradebook/gradebook.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file= 'gradebook';
 // $cidReset : This is the main difference with gradebook.php, here we say,
 // basically, that we are inside a course, and many things depend from that

main/gradebook/gradebook_add_cat.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 require_once '../inc/global.inc.php';
 $_in_course = true;

main/gradebook/gradebook_add_eval.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 require_once '../inc/global.inc.php';
 require_once 'lib/be.inc.php';

main/gradebook/gradebook_add_link.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_add_link_select_course.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file = 'gradebook';
 //$cidReset = true;

main/gradebook/gradebook_add_result.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_add_user.php

@@ -1,6 +1,13 @@
 <?php //$Id: gradebook_add_user.php 21153 2009-06-01 01:51:43Z yannoo $
 
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 //Disabling code when course code is null (gradebook as a tab) see issue #2705
 exit;

main/gradebook/gradebook_display_certificate.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file = 'gradebook';
 

main/gradebook/gradebook_edit_all.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file= 'gradebook';
 $cidReset= true;

main/gradebook/gradebook_edit_cat.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_edit_eval.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_edit_link.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = array('gradebook','link');
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_edit_result.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_flatview.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file = 'gradebook';
 

main/gradebook/gradebook_result.class.php

@@ -9,7 +9,10 @@
 
 
 if(!class_exists('GradeBookResult')):
-
+/**
+ * Gradebook results class
+ * @package chamilo.gradebook
+ */
 class GradeBookResult
 {
 	private $gradebook_list = array(); //stores the list of exercises

main/gradebook/gradebook_scoring_system.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file= 'gradebook';
 //$cidReset= true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_showlog_eval.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_showlog_link.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/gradebook_statistics.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file= 'gradebook';
 

main/gradebook/gradebook_view_result.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file[] = 'gradebook';
 

main/gradebook/index.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file= 'gradebook';
 // $cidReset : This is the main difference with gradebook.php, here we say,

main/gradebook/lib/be.inc.php

@@ -1,7 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-// include this file to have access to all backend classes
+/**
-// @author Bert Steppé
+ * include this file to have access to all backend classes
+ * @author Bert Steppé
+ */
+/**
+ * Code
+ */
 require_once api_get_path(LIBRARY_PATH).'sortabletable.class.php';
 define ('LIMIT', 1000);
 require_once 'be/gradebookitem.class.php';

main/gradebook/lib/be/abstractlink.class.php

@@ -9,6 +9,10 @@
  * @author Julio Montoya <gugli100@gmail.com> security improvements
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 abstract class AbstractLink implements GradebookItem {
 	// PROPERTIES
 

main/gradebook/lib/be/attendancelink.class.php

@@ -5,6 +5,10 @@
  * @author Christian Fasanando (christian1827@gmail.com)
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class AttendanceLink extends AbstractLink
 {
 

main/gradebook/lib/be/category.class.php

@@ -4,7 +4,10 @@
  * Defines a gradebook Category object
  * @package chamilo.gradebook
  */
- 
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class Category implements GradebookItem
 {
 

main/gradebook/lib/be/dropboxlink.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class DropboxLink extends EvalLink
 {
 

main/gradebook/lib/be/evallink.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 abstract class EvalLink extends AbstractLink
 {
 

main/gradebook/lib/be/evaluation.class.php

@@ -4,6 +4,10 @@
  * Defines a gradebook Evaluation object
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class Evaluation implements GradebookItem
 {
 

main/gradebook/lib/be/exerciselink.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class ExerciseLink extends AbstractLink
 {
 

main/gradebook/lib/be/forumthreadlink.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class ForumThreadLink extends AbstractLink
 {
 

main/gradebook/lib/be/gradebookitem.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Interface
+ * @package chamilo.gradebook
+ */
 interface GradebookItem
 {
 	public function get_item_type();

main/gradebook/lib/be/learnpathlink.class.php

@@ -6,6 +6,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class LearnpathLink extends AbstractLink
 {
 // INTERNAL VARIABLES

main/gradebook/lib/be/linkfactory.class.php

@@ -1,6 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 // To add your new link type here:
 // - define a unique type id
 // - add include

main/gradebook/lib/be/result.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé, Stijn Konings
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class Result
 {
 

main/gradebook/lib/be/studentpublicationlink.class.php

@@ -5,6 +5,10 @@
  * @author Bert Steppé
  * @package chamilo.gradebook
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class StudentPublicationLink extends AbstractLink
 {
 

main/gradebook/lib/be/surveylink.class.php

@@ -7,6 +7,10 @@
  * @package chamilo.gradebook
  */
 
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class SurveyLink extends AbstractLink
 {
     private $survey_table = null;

main/gradebook/lib/fe/catform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php';
@@ -7,7 +14,7 @@ require_once api_get_path(LIBRARY_PATH).'formvalidator/FormValidator.class.php';
 /**
  * Extends formvalidator with add&edit forms
  * @author Stijn Konings
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 
 class CatForm extends FormValidator {

main/gradebook/lib/fe/dataform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';
@@ -9,7 +16,7 @@ require_once api_get_path(LIBRARY_PATH) . 'formvalidator/FormValidator.class.php
 /**
  * Extends formvalidator with import and export forms
  * @author Stijn Konings
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 class DataForm extends FormValidator {
 

main/gradebook/lib/fe/displaygradebook.php

@@ -1,5 +1,13 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class DisplayGradebook
 {
 	/**

main/gradebook/lib/fe/evalform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';
@@ -8,7 +15,7 @@ require_once api_get_path(LIBRARY_PATH) . 'formvalidator/FormValidator.class.php
 /**
  * Extends formvalidator with add&edit forms for evaluations
  * @author Stijn Konings
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 
 $htmlHeadXtra[] = '<script type="text/javascript">

main/gradebook/lib/fe/exportgradebook.php

@@ -1,5 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
 /**
  * Prints an HTML page with a table containing the gradebook data
  * @param	array 	Array containing the data to be printed in the table

main/gradebook/lib/fe/flatviewtable.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 set_time_limit(0);
@@ -9,6 +16,7 @@ set_time_limit(0);
  * @author Stijn Konings
  * @author Bert Steppé  - (refactored, optimised)
  * @author Julio Montoya Armas - Gradebook Graphics
+ * @package chamilo.gradebook
  */
 class FlatViewTable extends SortableTable
 {

main/gradebook/lib/fe/gradebooktable.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
@@ -8,7 +15,7 @@ require_once dirname(__FILE__).'/../be.inc.php';
  * Table to display categories, evaluations and links
  * @author Stijn Konings
  * @author Bert Steppé (refactored, optimised)
- *
+ * @package chamilo.gradebook
  */
 class GradebookTable extends SortableTable
 {

main/gradebook/lib/fe/linkaddeditform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';
@@ -10,6 +17,7 @@ require_once api_get_path(LIBRARY_PATH) . 'formvalidator/FormValidator.class.php
  * Form used to add or edit links
  * @author Stijn Konings
  * @author Bert Steppé
+ * @package chamilo.gradebook
  */
 class LinkAddEditForm extends FormValidator
 {

main/gradebook/lib/fe/linkform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';
@@ -10,7 +17,7 @@ require_once api_get_path(LIBRARY_PATH) . 'formvalidator/FormValidator.class.php
  * Forms related to links
  * @author Stijn Konings
  * @author Bert Steppé (made more generic)
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 class LinkForm extends FormValidator
 {

main/gradebook/lib/fe/resulttable.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 
@@ -7,6 +14,7 @@ require_once dirname(__FILE__).'/../be.inc.php';
  * Table to display results for an evaluation
  * @author Stijn Konings
  * @author Bert Steppé
+ * @package chamilo.gradebook
  */
 class ResultTable extends SortableTable
 {

main/gradebook/lib/fe/scoredisplayform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';
 require_once api_get_path(LIBRARY_PATH) . 'groupmanager.lib.php';
@@ -8,7 +15,7 @@ require_once api_get_path(LIBRARY_PATH) . 'formvalidator/FormValidator.class.php
  * Form for the score display dialog
  * @author Stijn Konings
  * @author Bert Steppé
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 class ScoreDisplayForm extends FormValidator
 {

main/gradebook/lib/fe/userform.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 require_once dirname(__FILE__).'/../gradebook_functions.inc.php';

main/gradebook/lib/fe/usertable.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 require_once dirname(__FILE__).'/../../../inc/global.inc.php';
 require_once dirname(__FILE__).'/../be.inc.php';
 
@@ -7,6 +14,7 @@ require_once dirname(__FILE__).'/../be.inc.php';
  * Table to display flat view of a student's evaluations and links
  * @author Stijn Konings
  * @author Bert Steppé (refactored, optimised, use of caching, datagenerator class)
+ * @package chamilo.gradebook
  */
 class UserTable extends SortableTable
 {

main/gradebook/lib/flatview_data_generator.class.php

@@ -5,6 +5,10 @@
  * used for the teacher's flat view
  * @author Bert Steppé
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class FlatViewDataGenerator
 {
 

main/gradebook/lib/gradebook_data_generator.class.php

@@ -1,9 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
 /**
  * Class to select, sort and transform object data into array data,
  * used for the general gradebook view
  * @author Bert Steppé
+ * @package chamilo.gradebook
  */
 class GradebookDataGenerator
 {

main/gradebook/lib/gradebook_functions.inc.php

@@ -1,6 +1,9 @@
 <?php
 /* For licensing terms, see /license.txt */
-
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
 /**
 * These are functions used in gradebook
 *

main/gradebook/lib/results_data_generator.class.php

@@ -5,6 +5,10 @@
  * used for the teacher's evaluation results view
  * @author Bert Steppé
  */
+/**
+ * Class
+ * @package chamilo.gradebook
+ */
 class ResultsDataGenerator
 {
 

main/gradebook/lib/scoredisplay.class.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 // Score display types constants
 define('SCORE_DIV',                      1);    // X / Y
@@ -27,7 +34,7 @@ define('SCORE_ONLY_CUSTOM',3);
  * Class to display scores according to the settings made by the platform admin.
  * This class works as a singleton: call instance() to retrieve an object.
  * @author Bert Steppé
- * @package dokeos.gradebook
+ * @package chamilo.gradebook
  */
 class ScoreDisplay
 {

main/gradebook/lib/user_data_generator.class.php

@@ -1,9 +1,14 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
 /**
  * Class to select, sort and transform object data into array data,
  * used for a student's general view
  * @author Bert Steppé
+ * @package chamilo.gradebook
  */
 class UserDataGenerator
 {

main/gradebook/open_document.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 //Disabling code due issue #2705 gradebook with id "-1" 
 exit;
 /*

main/gradebook/user_info.php

@@ -1,5 +1,12 @@
 <?php // $Id: $
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 $language_file = 'gradebook';
 //$cidReset = true;
 require_once '../inc/global.inc.php';

main/gradebook/user_stats.php

@@ -1,5 +1,12 @@
 <?php
 /* For licensing terms, see /license.txt */
+/**
+ * Script
+ * @package chamilo.gradebook
+ */
+/**
+ * Init
+ */
 
 $language_file= 'gradebook';