code checking and cleaning

Author: TamaroWalter

classes/ratings.php

@@ -350,7 +350,7 @@ public static function moodleoverflow_sort_answers_by_ratings($posts) {
             $neworder[$post->id] = $post;
         }
 
-        // return now the sorted posts.
+        // Return now the sorted posts.
         return $neworder;
     }
 
@@ -813,6 +813,12 @@ public static function moodleoverflow_user_can_rate($post, $modulecontext, $user
             && $post->reviewed == 1;
     }
 
+    /**
+     * Sorts answerposts of a discussion with quicksort algorithm
+     * @param array $posts  the posts that are being sorted
+     * @param int   $low    the index from where the sorting begins
+     * @param int   $high   the index until the array is being sorted
+     */
     private static function moodleoverflow_quicksort_post_by_votes(array &$posts, $low, $high) {
         if ($low >= $high) {
             return;

classes/task/send_daily_mail.php

@@ -23,7 +23,6 @@
  */
 namespace mod_moodleoverflow\task;
 
-defined('MOODLE_INTERNAL') || die();
 /**
  * This task sends a daily mail of unread posts
  */

locallib.php

@@ -921,6 +921,7 @@ function moodleoverflow_user_can_post($modulecontext, $posttoreplyto, $considerr
  * @param stdClass $moodleoverflow The moodleoverflow object
  * @param stdClass $discussion     The discussion object
  * @param stdClass $post           The post object
+ * @param bool     $multiplemarks  The setting of multiplemarks (default: multiplemarks are not allowed)
  */
 function moodleoverflow_print_discussion($course, $cm, $moodleoverflow, $discussion, $post, $multiplemarks = false) {
     global $USER;
@@ -1118,6 +1119,7 @@ function moodleoverflow_get_all_discussion_posts($discussionid, $tracking, $modc
  * @param bool $iscomment
  * @param array $usermapping
  * @param int $level
+ * @param bool $multiplemarks setting of multiplemarks
  * @return void|null
  * @throws coding_exception
  * @throws dml_exception
@@ -1494,6 +1496,7 @@ function moodleoverflow_print_post($post, $discussion, $moodleoverflow, $cm, $co
  * @param array  $posts          Array of posts within the discussion
  * @param bool   $iscomment      Whether the current post is a comment
  * @param array $usermapping
+ * @param bool  $multiplemarks
  * @return string
  * @throws coding_exception
  * @throws dml_exception

tests/behat/behat_mod_moodleoverflow.php

@@ -128,7 +128,8 @@ protected function find_moodleoverflow_discussion_card(string $discussiontitle):
      *
      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
      *
-     * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist in the "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
+     * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should exist in the
+     *  "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
      * @throws ElementNotFoundException Thrown by behat_base::find
      * @param string $element The locator of the specified selector
      * @param string $selectortype The selector type
@@ -149,7 +150,8 @@ public function should_exist_in_the_moodleoverflow_discussion_card($element, $se
     /**
      * Click on the element of the specified type which is located inside the second element.
      *
-     * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" in the "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
+     * @When /^I click on "(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" in the
+     *  "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
      * @param string $element Element we look for
      * @param string $selectortype The type of what we look for
      * @param string $discussiontitle The discussion title
@@ -173,7 +175,8 @@ public function i_click_on_in_the_moodleoverflow_discussion_card($element, $sele
      *
      * This step is for advanced users, use it if you don't find anything else suitable for what you need.
      *
-     * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist in the "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
+     * @Then /^"(?P<element_string>(?:[^"]|\\")*)" "(?P<selector_string>[^"]*)" should not exist in the
+     *  "(?P<element2_string>(?:[^"]|\\")*)" moodleoverflow discussion card$/
      * @throws ExpectationException
      * @param string $element The locator of the specified selector
      * @param string $selectortype The selector type

tests/dailymail_test.php

@@ -134,6 +134,7 @@ private function helper_run_send_mails() {
 
     /**
      * Test if the task send_daily_mail sends a mail to the user.
+     * @covers \send_daily_mail::execute
      */
     public function test_mail_delivery() {
 
@@ -151,6 +152,7 @@ public function test_mail_delivery() {
 
     /**
      * Test if the content of the mail matches the supposed content.
+     * @covers \send_daily_mail::execute
      */
     public function test_content_of_mail_delivery() {
 
@@ -185,6 +187,7 @@ public function test_content_of_mail_delivery() {
 
     /**
      * Test if the task does not send a mail when maildigest = 0
+     * @covers \send_daily_mail::execute
      */
     public function test_mail_not_send() {
         // Creat user with daily_mail = off.
@@ -200,6 +203,7 @@ public function test_mail_not_send() {
 
     /**
      * Test if database is updated after sending a mail
+     * @covers \send_daily_mail::execute
      */
     public function test_records_removed() {
         global $DB;