From: tjhunt <tjhunt>
Date: Mon, 19 Mar 2007 17:22:46 +0000 (+0000)
Subject: Give the question bank code sensible PHPdocumentor package names.
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=4323d02959144b1210ef81b14560d1579668d701;p=moodle.git

Give the question bank code sensible PHPdocumentor package names.
---

diff --git a/question/backuplib.php b/question/backuplib.php
index 8403024aba..51a49dbd85 100644
--- a/question/backuplib.php
+++ b/question/backuplib.php
@@ -1,5 +1,10 @@
 <?php //$Id$
-    //This php script contains all the stuff to backup questions
+/**
+ * Question bank backup code.
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ *//** */
 
 //This is the "graphical" structure of the question database:
     //To see, put your terminal to 160cc
diff --git a/question/category.php b/question/category.php
index de930d2035..265972c4af 100644
--- a/question/category.php
+++ b/question/category.php
@@ -2,11 +2,10 @@
 /**
  * Allows a teacher to create, edit and delete categories
  *
- * @version $Id$
  * @author Martin Dougiamas and many others.
  *         {@link http://moodle.org}
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package question
+ * @package questionbank
  */
 
     require_once("../config.php");
diff --git a/question/category_class.php b/question/category_class.php
index de9c46df4a..e8815be290 100644
--- a/question/category_class.php
+++ b/question/category_class.php
@@ -1,18 +1,20 @@
 <?php // $Id$
 /**
- * Class question_category_object
+ * Class representing question categories
  *
- * Used for handling changes to the question categories
- *
- * @version $Id$
  * @author Martin Dougiamas and many others. {@link http://moodle.org}
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package question
+ * @package questionbank
  */
 
 // number of categories to display on page
 define( "PAGE_LENGTH",25 );
 
+/**
+ * Class representing question categories
+ * 
+ * @package questionbank
+ */
 class question_category_object {
 
     var $str;
diff --git a/question/edit.php b/question/edit.php
index a4c3a847af..b282040184 100644
--- a/question/edit.php
+++ b/question/edit.php
@@ -4,12 +4,11 @@
 *
 * TODO: add logging
 *
-* @version $Id$
 * @author Martin Dougiamas and many others. This has recently been extensively
 *         rewritten by Gustav Delius and other members of the Serving Mathematics project
 *         {@link http://maths.york.ac.uk/serving_maths}
 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package question
+* @package questionbank
 */
     require_once("../config.php");
     require_once("editlib.php");
diff --git a/question/editlib.php b/question/editlib.php
index 82cbfdd083..c8b518a805 100644
--- a/question/editlib.php
+++ b/question/editlib.php
@@ -1,17 +1,16 @@
 <?php // $Id$
 /**
-* Functions used by showbank.php to show question editing interface
-*
-* TODO: currently the function question_list still provides controls specific
-*       to the quiz module. This needs to be generalised.
-*
-* @version $Id$
-* @author Martin Dougiamas and many others. This has recently been extensively
-*         rewritten by members of the Serving Mathematics project
-*         {@link http://maths.york.ac.uk/serving_maths}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package question
-*/
+ * Functions used by showbank.php to show question editing interface
+ *
+ * TODO: currently the function question_list still provides controls specific
+ *       to the quiz module. This needs to be generalised.
+ *
+ * @author Martin Dougiamas and many others. This has recently been extensively
+ *         rewritten by members of the Serving Mathematics project
+ *         {@link http://maths.york.ac.uk/serving_maths}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ */
 
 require_once($CFG->libdir.'/questionlib.php');
 
diff --git a/question/export.php b/question/export.php
index 4437e6cef6..13d9575998 100644
--- a/question/export.php
+++ b/question/export.php
@@ -1,13 +1,13 @@
 <?php // $Id$
 /**
-* Export quiz questions into the given category
-*
-* @version $Id$
-* @author Martin Dougiamas, Howard Miller, and many others.
-*         {@link http://moodle.org}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package quiz
-*/
+ * Export quiz questions into the given category
+ *
+ * @author Martin Dougiamas, Howard Miller, and many others.
+ *         {@link http://moodle.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ * @subpackage importexport
+ */
 
     require_once("../config.php");
     require_once( "editlib.php" );
diff --git a/question/format.php b/question/format.php
index eb5c9f0b92..94ad5f62b3 100644
--- a/question/format.php
+++ b/question/format.php
@@ -1,13 +1,22 @@
 <?php  // $Id$ 
-
-////////////////////////////////////////////////////////////////////
-/// format.php  - Default format class for file imports/exports.  //
-///                                                               //
-/// Doesn't do everything on it's own -- it needs to be extended. //
-////////////////////////////////////////////////////////////////////
-
-// Included by import.php and export.php
-
+/**
+ * Base class for question import and export formats.
+ *
+ * @author Martin Dougiamas, Howard Miller, and many others.
+ *         {@link http://moodle.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ * @subpackage importexport
+ *//** */
+
+/**
+ * Base class for question import and export formats.
+ * 
+ * Doesn't do everything on it's own -- it needs to be extended.
+ * 
+ * @package questionbank
+ * @subpackage importexport
+ */
 class qformat_default {
 
     var $displayerrors = true;
diff --git a/question/import.php b/question/import.php
index fd34e2cf53..6a5900f5a1 100644
--- a/question/import.php
+++ b/question/import.php
@@ -1,13 +1,13 @@
 <?php // $Id$
 /**
-* Import quiz questions into the given category
-*
-* @version $Id$
-* @author Martin Dougiamas, Howard Miller, and many others.
-*         {@link http://moodle.org}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package quiz
-*/
+ * Import quiz questions into the given category
+ *
+ * @author Martin Dougiamas, Howard Miller, and many others.
+ *         {@link http://moodle.org}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ * @subpackage importexport
+ */
 
     require_once("../config.php");
     require_once("editlib.php" );
diff --git a/question/preview.php b/question/preview.php
index b5389efd17..16ca53f5bc 100644
--- a/question/preview.php
+++ b/question/preview.php
@@ -1,20 +1,19 @@
 <?php // $Id$
 /**
-* This page displays a preview of a question
-*
-* The preview uses the option settings from the activity within which the question
-* is previewed or the default settings if no activity is specified. The question session
-* information is stored in the session as an array of subsequent states rather
-* than in the database.
-*
-* TODO: make this work with activities other than quiz
-*
-* @version $Id$
-* @author Alex Smith as part of the Serving Mathematics project
-*         {@link http://maths.york.ac.uk/serving_maths}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package question
-*/
+ * This page displays a preview of a question
+ *
+ * The preview uses the option settings from the activity within which the question
+ * is previewed or the default settings if no activity is specified. The question session
+ * information is stored in the session as an array of subsequent states rather
+ * than in the database.
+ *
+ * TODO: make this work with activities other than quiz
+ *
+ * @author Alex Smith as part of the Serving Mathematics project
+ *         {@link http://maths.york.ac.uk/serving_maths}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ */
 
     require_once("../config.php");
     require_once($CFG->libdir.'/questionlib.php');
diff --git a/question/question.php b/question/question.php
index 61615236ab..384948838d 100644
--- a/question/question.php
+++ b/question/question.php
@@ -1,4 +1,4 @@
-<?php
+<?php // $Id$
 /**
  * Page for editing questions
  *
@@ -10,12 +10,11 @@
  * TODO: currently this still treats the quiz as special
  * TODO: question versioning is not currently enabled
  *
- * @version $Id$
  * @author Martin Dougiamas and many others. This has recently been extensively
  *         rewritten by members of the Serving Mathematics project
  *         {@link http://maths.york.ac.uk/serving_maths}
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package question
+ * @package questionbank
  *//** */
 
     require_once(dirname(__FILE__) . '/../config.php');
diff --git a/question/question2.php b/question/question2.php
index 8dd7bb4364..bd5d40588c 100644
--- a/question/question2.php
+++ b/question/question2.php
@@ -6,7 +6,7 @@
  *
  * @author T.J.Hunt@open.ac.uk
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package question
+ * @package questionbank
  *//** */
 
 // Includes.
diff --git a/question/restorelib.php b/question/restorelib.php
index 55e28cafe6..a0a18b00ad 100644
--- a/question/restorelib.php
+++ b/question/restorelib.php
@@ -1,5 +1,10 @@
 <?php //$Id$
-    //This php script contains all the stuff to restore questions
+/**
+ * Question bank restore code.
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ *//** */
 
 // Todo:
     // the restoration of the parent and sortorder fields in the category table needs
diff --git a/question/showbank.php b/question/showbank.php
index 68c4e0987c..02ff828732 100644
--- a/question/showbank.php
+++ b/question/showbank.php
@@ -1,22 +1,22 @@
 <?php // $Id$
 /**
-* Shows the question bank editing interface. To be included by other pages
-*
-* The script also processes a number of actions:
-* Actions affecting the question pool:
-* move         Moves a question to a different category
-* deleteselected Deletes the selected questions from the category
-* Other actions:
-* cat          Chooses the category
-* displayoptions Sets display options
-*
-* @version $Id$
-* @author Martin Dougiamas and many others. This has recently been extensively
-*         rewritten by Gustav Delius and other members of the Serving Mathematics project
-*         {@link http://maths.york.ac.uk/serving_maths}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package question
-*/
+ * Shows the question bank editing interface. To be included by other pages
+ *
+ * The script also processes a number of actions:
+ * 
+ * Actions affecting the question pool:
+ * move           Moves a question to a different category
+ * deleteselected Deletes the selected questions from the category
+ * Other actions:
+ * cat            Chooses the category
+ * displayoptions Sets display options
+ *
+ * @author Martin Dougiamas and many others. This has recently been extensively
+ *         rewritten by Gustav Delius and other members of the Serving Mathematics project
+ *         {@link http://maths.york.ac.uk/serving_maths}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ */
 
     // Make sure this can only be used from within Moodle scripts
     defined('MOODLE_INTERNAL') or die('Direct access to this script is forbidden.');
diff --git a/question/tabs.php b/question/tabs.php
index 8a64cfbbfa..e34c0de232 100644
--- a/question/tabs.php
+++ b/question/tabs.php
@@ -1,11 +1,10 @@
 <?php  // $Id$
 /**
-* Sets up the tabs used by the question bank editing page
-*
-* @version $Id$
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package question
-*/
+ * Sets up the tabs used by the question bank editing page
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ */
 
 /// This file to be included so we can assume config.php has already been included.
 
diff --git a/question/type/edit_question_form.php b/question/type/edit_question_form.php
index 04d74e0e80..505e56eb14 100644
--- a/question/type/edit_question_form.php
+++ b/question/type/edit_question_form.php
@@ -5,7 +5,8 @@
  * @copyright &copy; 2006 The Open University
  * @author T.J.Hunt@open.ac.uk
  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package quiz
+ * @package questionbank
+ * @subpackage questiontypes
  *//** */
 
 /**
@@ -13,6 +14,9 @@
  * all question types need. Question types should define their own
  * class that inherits from this one, and implements the definition_inner()
  * method.
+ * 
+ * @package questionbank
+ * @subpackage questiontypes
  */
 class question_edit_form extends moodleform {
     /**
diff --git a/question/type/questiontype.php b/question/type/questiontype.php
index 69cabe8b7c..0bb442b140 100644
--- a/question/type/questiontype.php
+++ b/question/type/questiontype.php
@@ -1,15 +1,15 @@
 <?php  // $Id$
 /**
-* The default questiontype class.
-*
-* @version $Id$
-* @author Martin Dougiamas and many others. This has recently been completely
-*         rewritten by Alex Smith, Julian Sedding and Gustav Delius as part of
-*         the Serving Mathematics project
-*         {@link http://maths.york.ac.uk/serving_maths}
-* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
-* @package quiz
-*//** */
+ * The default questiontype class.
+ *
+ * @author Martin Dougiamas and many others. This has recently been completely
+ *         rewritten by Alex Smith, Julian Sedding and Gustav Delius as part of
+ *         the Serving Mathematics project
+ *         {@link http://maths.york.ac.uk/serving_maths}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package questionbank
+ * @subpackage questiontypes
+ *//** */
 
 require_once($CFG->libdir . '/questionlib.php');
 
@@ -25,6 +25,9 @@ require_once($CFG->libdir . '/questionlib.php');
  * experiences of the first few question type implementors, and improve the
  * interface to meet their needs, rather the freeze the API prematurely and
  * condem everyone to working round a clunky interface for ever afterwards.
+ * 
+ * @package questionbank
+ * @subpackage questiontypes
  */
 class default_questiontype {