MDL-20636 Fix @Package names and PHPdoc layout.

safatshahin · Feb 23, 2011 · 7764183 · 7764183
1 parent 017bc1d
commit 7764183
Show file tree

Hide file tree

Showing 130 changed files with 818 additions and 665 deletions.
diff --git a/question/format/aiken/lang/en/qformat_aiken.php b/question/format/aiken/lang/en/qformat_aiken.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_aiken', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_aiken
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage aiken
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['aiken'] = 'Aiken format';

diff --git a/question/format/blackboard/lang/en/qformat_blackboard.php b/question/format/blackboard/lang/en/qformat_blackboard.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_blackboard', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_blackboard
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage blackboard
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['blackboard'] = 'Blackboard';

diff --git a/question/format/blackboard_six/lang/en/qformat_blackboard_six.php b/question/format/blackboard_six/lang/en/qformat_blackboard_six.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_blackboard_six', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_blackboard_six
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage blackboard_six
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['blackboard_six'] = 'Blackboard V6+';

diff --git a/question/format/examview/lang/en/qformat_examview.php b/question/format/examview/lang/en/qformat_examview.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_examview', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_examview
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage examview
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['examview'] = 'Examview';

diff --git a/question/format/gift/lang/en/qformat_gift.php b/question/format/gift/lang/en/qformat_gift.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_gift', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_gift
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage gift
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['nohandler'] = 'No handler for question type {$a}';

diff --git a/question/format/gift/simpletest/testgiftformat.php b/question/format/gift/simpletest/testgiftformat.php
@@ -19,9 +19,10 @@
 /**
  * Unit tests for the Moodle GIFT format.
  *
- * @package qformat_xml
- * @copyright 2010 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage gift
+ * @copyright  2010 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->libdir . '/questionlib.php');

diff --git a/question/format/learnwise/lang/en/qformat_learnwise.php b/question/format/learnwise/lang/en/qformat_learnwise.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_learnwise', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_learnwise
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage learnwise
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['learnwise'] = 'Learnwise format';

diff --git a/question/format/missingword/lang/en/qformat_missingword.php b/question/format/missingword/lang/en/qformat_missingword.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_missingword', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_missingword
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage missingword
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['missingword'] = 'Missing word format';

diff --git a/question/format/multianswer/format.php b/question/format/multianswer/format.php
@@ -18,19 +18,19 @@
 /**
  * Embedded answer (Cloze) question importer.
  *
- * @package qformat
- * @subpackage qformat_multianswer
- * @copyright 2003 Henrik Kaipe
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage multianswer
+ * @copyright  2003 Henrik Kaipe
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 
 /**
  * Importer that imports a text file containing a single Multianswer question
  * from a text file.
  *
- * @copyright 2003 Henrik Kaipe
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2003 Henrik Kaipe
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class qformat_multianswer extends qformat_default {
 

diff --git a/question/format/multianswer/lang/en/qformat_multianswer.php b/question/format/multianswer/lang/en/qformat_multianswer.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_multianswer', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_multianswer
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage multianswer
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['multianswer'] = 'Embedded answers (Cloze)';

diff --git a/question/format/qti_two/lang/en/qformat_qti_two.php b/question/format/qti_two/lang/en/qformat_qti_two.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_qti_two', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_qti_two
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage qti_two
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['qti_two'] = 'IMS QTI 2.0 format';

diff --git a/question/format/qti_two/qt_common.php b/question/format/qti_two/qt_common.php
@@ -31,11 +31,8 @@
  * @param int courseid
  * @return array containing filenames
  * @calledfrom type/<typename>/editquestion.php
- * @package questionbank
- * @subpackage importexport
  */
-function get_course_media_files($courseid)
-{
+function get_course_media_files($courseid) {
 // this code lifted from mod/quiz/question.php and modified
 throw new coding_exception('qti_two not converted to new fil api yet, sorry');
     /*global $CFG;

diff --git a/question/format/webct/lang/en/qformat_webct.php b/question/format/webct/lang/en/qformat_webct.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_webct', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_webct
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage webct
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['webct'] = 'WebCT format';

diff --git a/question/format/xhtml/lang/en/qformat_xhtml.php b/question/format/xhtml/lang/en/qformat_xhtml.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_xhtml', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_xhtml
- * @copyright 2010 Helen Foster
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage xhtml
+ * @copyright  2010 Helen Foster
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['xhtml'] = 'XHTML format';

diff --git a/question/format/xml/format.php b/question/format/xml/format.php
@@ -19,10 +19,10 @@
 /**
  * Code for exporting questions as Moodle XML.
  *
- * @package qformat
+ * @package    qformat
  * @subpackage xml
  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 
@@ -36,7 +36,7 @@
  * See http://docs.moodle.org/en/Moodle_XML_format for a description of the format.
  *
  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class qformat_xml extends qformat_default {
 

diff --git a/question/format/xml/lang/en/qformat_xml.php b/question/format/xml/lang/en/qformat_xml.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qformat_xml', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qformat_xml
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage xml
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['invalidxml'] = 'Invalid XML file - string expected (use CDATA?)';

diff --git a/question/format/xml/simpletest/testxmlformat.php b/question/format/xml/simpletest/testxmlformat.php
@@ -19,9 +19,10 @@
 /**
  * Unit tests for the Moodle XML format.
  *
- * @package qformat_xml
- * @copyright 2010 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qformat
+ * @subpackage xml
+ * @copyright  2010 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once($CFG->libdir . '/questionlib.php');
@@ -31,8 +32,8 @@
 /**
  * Unit tests for the matching question definition class.
  *
- * @copyright 2009 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class qformat_xml_test extends UnitTestCase {
     public function assert_same_xml($expectedxml, $xml) {

diff --git a/question/preview.php b/question/preview.php
@@ -24,10 +24,10 @@
  * than in the database.
  *
  * @package    moodlecore
- * @subpackage questionbank
+ * @subpackage questionengine
  * @copyright  Alex Smith {@link http://maths.york.ac.uk/serving_maths} and
  *      numerous contributors.
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 

diff --git a/question/type/calculated/lang/en/qtype_calculated.php b/question/type/calculated/lang/en/qtype_calculated.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qtype_calculated', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qtype_calculated
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qtype
+ * @subpackage calculated
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['addingcalculated'] = 'Adding a calculated question';

diff --git a/question/type/calculated/lib.php b/question/type/calculated/lib.php
@@ -18,11 +18,16 @@
 /**
  * Serve question type files
  *
- * @since 2.0
- * @package questionbank
- * @subpackage questiontypes
- * @author Dongsheng Cai <dongsheng@moodle.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      2.0
+ * @package    qtype
+ * @subpackage calculated
+ * @copyright  Dongsheng Cai <dongsheng@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * Checks file access for calculated questions.
  */
 function qtype_calculated_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
     global $CFG;

diff --git a/question/type/calculatedmulti/lang/en/qtype_calculatedmulti.php b/question/type/calculatedmulti/lang/en/qtype_calculatedmulti.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qtype_calculatedmulti', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qtype_calculatedmulti
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qtype
+ * @subpackage calculatedmulti
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['addingcalculatedmulti'] = 'Adding a Calculated multichoice question';

diff --git a/question/type/calculatedmulti/lib.php b/question/type/calculatedmulti/lib.php
@@ -18,11 +18,16 @@
 /**
  * Serve question type files
  *
- * @since 2.0
- * @package questionbank
- * @subpackage questiontypes
- * @author Dongsheng Cai <dongsheng@moodle.com>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      2.0
+ * @package    qtype
+ * @subpackage calculatedmulti
+ * @copyright  Dongsheng Cai <dongsheng@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * Checks file access for calculated multiple-choice questions.
  */
 function qtype_calculatedmulti_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
     global $DB, $CFG;

diff --git a/question/type/calculatedsimple/lang/en/qtype_calculatedsimple.php b/question/type/calculatedsimple/lang/en/qtype_calculatedsimple.php
@@ -18,9 +18,10 @@
 /**
  * Strings for component 'qtype_calculatedsimple', language 'en', branch 'MOODLE_20_STABLE'
  *
- * @package   qtype_calculatedsimple
- * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    qtype
+ * @subpackage calculatedsimple
+ * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 $string['addingcalculatedsimple'] = 'Adding a Simple calculated question';

diff --git a/question/type/calculatedsimple/lib.php b/question/type/calculatedsimple/lib.php
@@ -18,11 +18,16 @@
 /**
  * Serve question type files
  *
- * @since 2.0
- * @package questionbank
- * @subpackage questiontypes
- * @author Dongsheng Cai <dongsheng@moodle.com>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since      2.0
+ * @package    qtype
+ * @subpackage calculatedsimple
+ * @copyright  Dongsheng Cai <dongsheng@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+/**
+ * Checks file access for simple calculated questions.
  */
 function qtype_calculatedsimple_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
     global $CFG;