phpdoc compliance

marcusgreen · Mar 4, 2024 · 570bcdc · 570bcdc
1 parent e4d1ac4
commit 570bcdc
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 12 deletions.
diff --git a/backup/moodle2/backup_qtype_aitext_plugin.class.php b/backup/moodle2/backup_qtype_aitext_plugin.class.php
@@ -15,8 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
- * @subpackage backup-moodle2
+ * Aitext backup
+ *
+ * @package    qtype_aitext
  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/backup/moodle2/restore_qtype_aitext_plugin.class.php b/backup/moodle2/restore_qtype_aitext_plugin.class.php
@@ -15,14 +15,18 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @package    moodlecore
+ * Aitext question type backup
+ *
+ * @package    qtype_aitext
  * @subpackage backup-moodle2
  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 
 /**
+ * Provide the necessary information needed to restore one aitext instance
+ *
  * restore plugin class that provides the necessary information
  * needed to restore one aitext qtype plugin
  *
@@ -42,6 +46,9 @@ protected function define_question_plugin_structure() {
 
     /**
      * Process the qtype/aitext element
+     *
+     * @param array $data
+     * @return void
      */
     public function process_aitext($data) {
         global $DB;

diff --git a/db/upgrade.php b/db/upgrade.php
@@ -17,7 +17,7 @@
 /**
  * Essay question type upgrade code.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage essay
  * @copyright  2011 The Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/db/upgradelib.php b/db/upgradelib.php
@@ -17,7 +17,7 @@
 /**
  * Upgrade library code for the essay question type.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage essay
  * @copyright  2010 The Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/edit_aitext_form.php b/edit_aitext_form.php
@@ -17,7 +17,7 @@
 /**
  * Defines the editing form for the aitext question type.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage aitext
  * @author  2023 Marcus Green
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/lang/en/qtype_aitext.php b/lang/en/qtype_aitext.php
@@ -17,7 +17,7 @@
 /**
  * Strings for component 'qtype_aitext', language 'en'
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage aitext
  * @copyright  2024 Marcus Green
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/question.php b/question.php
@@ -17,7 +17,7 @@
 /**
  * aitext question definition class.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage aitext
  * @copyright  2024 Marcus Green
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -75,9 +75,14 @@ public function compute_final_grade($responses, $totaltries) {
 
         return true;
     }
+    /**
+     * Re-initialise the state during a quiz (or question use)
+     *
+     * @param question_attempt_step $step
+     * @return void
+     */
     public function apply_attempt_state(question_attempt_step $step) {
         $this->step = $step;
-
     }
 
     /**

diff --git a/questiontype.php b/questiontype.php
@@ -17,7 +17,7 @@
 /**
  * Question type class for the aitext question type.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage aitext
  * @author     Marcus Green
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/renderer.php b/renderer.php
@@ -18,7 +18,7 @@
  * aitext question renderer class. Based on core Moodle qtype_essay
  * which has its origins at the UK Open University
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage aitext
  * @author     2023 Marcus Green
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -33,6 +33,14 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class qtype_aitext_renderer extends qtype_renderer {
+    /**
+     * Generate the display of the formulation part of the question shown at runtime
+     * in a quiz
+     *
+     * @param question_attempt $qa
+     * @param question_display_options $options
+     * @return string
+     */
     public function formulation_and_controls(question_attempt $qa,
             question_display_options $options) {
         global $CFG;

diff --git a/version.php b/version.php
@@ -17,7 +17,7 @@
 /**
  * Version information for the essay question type.
  *
- * @package    qtype
+ * @package    qtype_aitext
  * @subpackage essay
  * @copyright  2005 Mark Nielsen
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later