MDL-38792 Update question/type in-line comments to codechecker standards

Correct bad formated infiles in question/type directories

question/type/calculated/backup/moodle1/lib.php

@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -47,12 +46,12 @@ public function get_question_subpaths() {
      */
     public function process_question(array $data, array $raw) {
 
-        // convert and write the answers first
+        // Convert and write the answers first.
         if (isset($data['answers'])) {
             $this->write_answers($data['answers'], $this->pluginname);
         }
 
-        // convert and write the numerical units and numerical options
+        // Convert and write the numerical units and numerical options.
         if (isset($data['calculated'][0]['numerical_units'])) {
             $numericalunits = $data['calculated'][0]['numerical_units'];
         } else {
@@ -64,15 +63,15 @@ public function process_question(array $data, array $raw) {
         $this->write_numerical_units($numericalunits);
         $this->write_numerical_options($numericaloptions);
 
-        // write dataset_definitions
+        // Write dataset_definitions.
         if (isset($data['calculated'][0]['dataset_definitions']['dataset_definition'])) {
             $datasetdefinitions = $data['calculated'][0]['dataset_definitions']['dataset_definition'];
         } else {
             $datasetdefinitions = array();
         }
         $this->write_dataset_definitions($datasetdefinitions);
 
-        // write calculated_records
+        // Write calculated_records.
         $this->xmlwriter->begin_tag('calculated_records');
         foreach ($data['calculated'] as $calculatedrecord) {
             $record = array(
@@ -87,7 +86,7 @@ public function process_question(array $data, array $raw) {
         }
         $this->xmlwriter->end_tag('calculated_records');
 
-        // write calculated_options
+        // Write calculated_options.
         $options = array(
             'calculate_option' => array(
                 'id'                             => $this->converter->get_nextid(),

question/type/calculated/backup/moodle2/backup_qtype_calculated_plugin.class.php

@@ -38,31 +38,31 @@ class backup_qtype_calculated_plugin extends backup_qtype_plugin {
      */
     protected function define_question_plugin_structure() {
 
-        // Define the virtual plugin element with the condition to fulfill
+        // Define the virtual plugin element with the condition to fulfill.
         // Note: we use $this->pluginname so for extended plugins this will work
-        // automatically: calculatedsimple and calculatedmulti
+        // automatically: calculatedsimple and calculatedmulti.
         $plugin = $this->get_plugin_element(null, '../../qtype', $this->pluginname);
 
-        // Create one standard named plugin element (the visible container)
+        // Create one standard named plugin element (the visible container).
         $pluginwrapper = new backup_nested_element($this->get_recommended_name());
 
-        // connect the visible container ASAP
+        // Connect the visible container ASAP.
         $plugin->add_child($pluginwrapper);
 
         // This qtype uses standard question_answers, add them here
-        // to the tree before any other information that will use them
+        // to the tree before any other information that will use them.
         $this->add_question_question_answers($pluginwrapper);
 
-        // This qtype uses standard numerical units, add them here
+        // This qtype uses standard numerical units, add them here.
         $this->add_question_numerical_units($pluginwrapper);
 
-        // This qtype uses standard numerical options, add them here
+        // This qtype uses standard numerical options, add them here.
         $this->add_question_numerical_options($pluginwrapper);
 
-        // This qtype uses standard datasets, add them here
+        // This qtype uses standard datasets, add them here.
         $this->add_question_datasets($pluginwrapper);
 
-        // Now create the qtype own structures
+        // Now create the qtype own structures.
         $calculatedrecords = new backup_nested_element('calculated_records');
         $calculatedrecord = new backup_nested_element('calculated_record', array('id'), array(
             'answer', 'tolerance', 'tolerancetype', 'correctanswerlength',
@@ -74,20 +74,20 @@ protected function define_question_plugin_structure() {
             'correctfeedbackformat', 'partiallycorrectfeedback', 'partiallycorrectfeedbackformat',
             'incorrectfeedback', 'incorrectfeedbackformat', 'answernumbering'));
 
-        // Now the own qtype tree
+        // Now the own qtype tree.
         $pluginwrapper->add_child($calculatedrecords);
         $calculatedrecords->add_child($calculatedrecord);
 
         $pluginwrapper->add_child($calculatedoptions);
         $calculatedoptions->add_child($calculatedoption);
 
-        // set source to populate the data
+        // Set source to populate the data.
         $calculatedrecord->set_source_table('question_calculated',
                 array('question' => backup::VAR_PARENTID));
         $calculatedoption->set_source_table('question_calculated_options',
                 array('question' => backup::VAR_PARENTID));
 
-        // don't need to annotate ids nor files
+        // Don't need to annotate ids nor files.
 
         return $plugin;
     }

question/type/calculated/backup/moodle2/restore_qtype_calculated_plugin.class.php

@@ -41,17 +41,17 @@ protected function define_question_plugin_structure() {
 
         $paths = array();
 
-        // This qtype uses question_answers, add them
+        // This qtype uses question_answers, add them.
         $this->add_question_question_answers($paths);
 
-        // This qtype uses question_numerical_options and question_numerical_units, add them
+        // This qtype uses question_numerical_options and question_numerical_units, add them.
         $this->add_question_numerical_options($paths);
         $this->add_question_numerical_units($paths);
 
-        // This qtype uses question datasets, add them
+        // This qtype uses question datasets, add them.
         $this->add_question_datasets($paths);
 
-        // Add own qtype stuff
+        // Add own qtype stuff.
         $elename = 'calculated_record';
         $elepath = $this->get_pathfor('/calculated_records/calculated_record');
         $paths[] = new restore_path_element($elename, $elepath);
@@ -60,7 +60,7 @@ protected function define_question_plugin_structure() {
         $elepath = $this->get_pathfor('/calculated_options/calculated_option');
         $paths[] = new restore_path_element($elename, $elepath);
 
-        return $paths; // And we return the interesting paths
+        return $paths; // And we return the interesting paths.
     }
 
     /**
@@ -72,19 +72,19 @@ public function process_calculated_record($data) {
         $data = (object)$data;
         $oldid = $data->id;
 
-        // Detect if the question is created or mapped
+        // Detect if the question is created or mapped.
         $oldquestionid   = $this->get_old_parentid('question');
         $newquestionid   = $this->get_new_parentid('question');
         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ?
                 true : false;
 
         // If the question has been created by restore, we need to create its
-        // question_calculated too
+        // question_calculated too.
         if ($questioncreated) {
-            // Adjust some columns
+            // Adjust some columns.
             $data->question = $newquestionid;
             $data->answer = $this->get_mappingid('question_answer', $data->answer);
-            // Insert record
+            // Insert record.
             $newitemid = $DB->insert_record('question_calculated', $data);
         }
     }
@@ -98,18 +98,18 @@ public function process_calculated_option($data) {
         $data = (object)$data;
         $oldid = $data->id;
 
-        // Detect if the question is created or mapped
+        // Detect if the question is created or mapped.
         $oldquestionid   = $this->get_old_parentid('question');
         $newquestionid   = $this->get_new_parentid('question');
         $questioncreated = $this->get_mappingid('question_created', $oldquestionid) ?
                 true : false;
 
         // If the question has been created by restore, we need to create its
-        // question_calculated too
+        // question_calculated too.
         if ($questioncreated) {
-            // Adjust some columns
+            // Adjust some columns.
             $data->question = $newquestionid;
-            // Insert record
+            // Insert record.
             $newitemid = $DB->insert_record('question_calculated_options', $data);
         }
     }

question/type/calculated/datasetdefinitions_form.php

@@ -92,7 +92,7 @@ protected function definition() {
         $datadefscat  = $this->qtypeobj->get_dataset_definitions_category($this->question);
         $datasetmenus = array();
         $label = "<div class='mdl-align'>".get_string('datasetrole', 'qtype_calculated')."</div>";
-        // explaining the role of datasets so other strings can be shortened
+        // Explaining the role of datasets so other strings can be shortened.
         $mform->addElement('html', $label);
         $mform->addElement('header', 'mandatoryhdr',
                 get_string('mandatoryhdr', 'qtype_calculated'));
@@ -136,7 +136,7 @@ protected function definition() {
                 $key++;
             }
         }
-        // temporary strings
+        // Temporary strings.
         $mform->addElement('header', 'synchronizehdr',
                 get_string('synchronize', 'qtype_calculated'));
         $mform->addElement('radio', 'synchronize', '',

question/type/calculated/datasetitems_form.php

@@ -80,7 +80,7 @@ public function __construct($submiturl, $question, $regenerate) {
         }
         $this->category = $category;
         $this->categorycontext = context::instance_by_id($category->contextid);
-        //get the dataset defintions for this question
+        // Get the dataset defintions for this question.
         if (empty($question->id)) {
             $this->datasetdefs = $this->qtypeobj->get_dataset_definitions(
                     $question->id, $SESSION->calculated->definitionform->dataset);
@@ -93,7 +93,7 @@ public function __construct($submiturl, $question, $regenerate) {
         }
 
         foreach ($this->datasetdefs as $datasetdef) {
-            // Get maxnumber
+            // Get maxnumber.
             if ($this->maxnumber == -1 || $datasetdef->itemcount < $this->maxnumber) {
                 $this->maxnumber = $datasetdef->itemcount;
             }
@@ -108,8 +108,7 @@ public function __construct($submiturl, $question, $regenerate) {
     }
 
     protected function definition() {
-                $labelsharedwildcard = get_string("sharedwildcard", "qtype_calculated");
-
+        $labelsharedwildcard = get_string("sharedwildcard", "qtype_calculated");
         $mform =& $this->_form;
         $mform->setDisableShortforms();
 
@@ -124,7 +123,7 @@ protected function definition() {
         $html2 = $this->qtypeobj->print_dataset_definitions_category_shared(
                 $this->question, $this->datasetdefs);
         $mform->addElement('static', 'listcategory', $label, $html2);
-        //----------------------------------------------------------------------
+        // ...----------------------------------------------------------------------.
         $mform->addElement('submit', 'updatedatasets',
                 get_string('updatedatasetparam', 'qtype_calculated'));
         $mform->registerNoSubmitButton('updatedatasets');
@@ -269,7 +268,7 @@ protected function definition() {
         $mform->addGroup($addgrp1, 'addgrp1', '', '   ', false);
         $mform->registerNoSubmitButton('showbutton');
         $mform->closeHeaderBefore('addgrp1');
-        //----------------------------------------------------------------------
+        // ...----------------------------------------------------------------------.
         $j = $this->noofitems * count($this->datasetdefs);
         $k = optional_param('selectshow', 1, PARAM_INT);
         for ($i = $this->noofitems; $i >= 1; $i--) {
@@ -301,9 +300,9 @@ protected function definition() {
                 $j--;
             }
             if ('' != $strquestionlabel && ($k > 0 )) {
-                //||  $this->outsidelimit || !empty($this->numbererrors )
+                // ... $this->outsidelimit || !empty($this->numbererrors ).
                 $repeated[] = $mform->addElement('static', "answercomment[$i]", $strquestionlabel);
-                // decode equations in question text
+                // Decode equations in question text.
                 $qtext = $this->qtypeobj->substitute_variables(
                         $this->question->questiontext, $data);
                 $textequations = $this->qtypeobj->find_math_equations($qtext);
@@ -326,8 +325,8 @@ protected function definition() {
 
         }
         $mform->addElement('static', 'outsidelimit', '', '');
-        //----------------------------------------------------------------------
-        // Non standard name for button element needed so not using add_action_buttons
+        // ...----------------------------------------------------------------------
+        // Non standard name for button element needed so not using add_action_buttons.
         if (!($this->noofitems==0) ) {
             $mform->addElement('submit', 'savechanges', get_string('savechanges'));
             $mform->closeHeaderBefore('savechanges');
@@ -387,7 +386,7 @@ public function set_data($question) {
                 }
             }
         }
-        //fill out all data sets and also the fields for the next item to add.
+        // Fill out all data sets and also the fields for the next item to add.
         $j = $this->noofitems * count($this->datasetdefs);
         for ($itemnumber = $this->noofitems; $itemnumber >= 1; $itemnumber--) {
             $data = array();
@@ -416,8 +415,8 @@ public function set_data($question) {
         $formdata['selectdelete'] = '1';
         $formdata['selectadd'] = '1';
         $j = $this->noofitems * count($this->datasetdefs)+1;
-        $data = array(); // data for comment_on_datasetitems later
-        //dataset generation dafaults
+        $data = array(); // Data for comment_on_datasetitems later.
+        // Dataset generation defaults.
         if ($this->qtypeobj->supports_dataset_item_generation()) {
             $itemnumber = $this->noofitems+1;
             foreach ($this->datasetdefs as $defid => $datasetdef) {
@@ -436,7 +435,7 @@ public function set_data($question) {
             }
         }
 
-        //existing records override generated data depending on radio element
+        // Existing records override generated data depending on radio element.
         $j = $this->noofitems * count($this->datasetdefs) + 1;
         if (!$this->regenerate && !optional_param('updatedatasets', false, PARAM_BOOL) &&
                 !optional_param('updateanswers', false, PARAM_BOOL)) {

question/type/calculated/db/upgrade.php

@@ -36,17 +36,14 @@ function xmldb_qtype_calculated_upgrade($oldversion) {
 
     $dbman = $DB->get_manager();
 
-
     // Moodle v2.2.0 release upgrade line
-    // Put any upgrade step following this
+    // Put any upgrade step following this.
 
     // Moodle v2.3.0 release upgrade line
-    // Put any upgrade step following this
-
+    // Put any upgrade step following this.
 
     // Moodle v2.4.0 release upgrade line
-    // Put any upgrade step following this
-
+    // Put any upgrade step following this.
 
     return true;
 }

question/type/calculated/db/upgradelib.php

@@ -83,7 +83,7 @@ public function right_answer() {
     protected function parse_response($state) {
         if (strpos($state->answer, '-') < 7) {
             // Broken state, skip it.
-            throw new coding_exception("Brokes state {$state->id} for calcluated
+            throw new coding_exception("Brokes state {$state->id} for calculated
                     question {$state->question}. (It did not specify a dataset.");
         }
         list($datasetbit, $realanswer) = explode('-', $state->answer, 2);
@@ -92,7 +92,7 @@ protected function parse_response($state) {
         if (is_null($this->selecteditem)) {
             $this->load_dataset($selecteditem);
         } else if ($this->selecteditem != $selecteditem) {
-            $this->logger->log_assumption("Different states for calcluated question
+            $this->logger->log_assumption("Different states for calculated question
                     {$state->question} used different dataset items. Ignoring the change
                     in state {$state->id} and coninuting to use item {$this->selecteditem}.");
         }
@@ -248,7 +248,7 @@ public function calculate($expression) {
      * @return float the computed result.
      */
     protected function calculate_raw($expression) {
-        // This validation trick from http://php.net/manual/en/function.eval.php
+        // This validation trick from http://php.net/manual/en/function.eval.php.
         if (!@eval('return true; $result = ' . $expression . ';')) {
             return '[Invalid expression ' . $expression . ']';
         }

question/type/calculated/edit_calculated_form.php

@@ -146,7 +146,7 @@ protected function definition_inner($mform) {
                 $mform->createElement('submit', $addfieldsname, $addstring), 'listcategory');
         $mform->registerNoSubmitButton('createoptionbutton');
 
-        // Editing as regular.
+        // Editing as regular question.
         $mform->setType('single', PARAM_INT);
 
         $mform->addElement('hidden', 'shuffleanswers', '1');