MDL-53102 tests: corrected phpdocs in email diversion tests
authorBrendan Heywood <brendan@catalyst-au.net>
Wed, 2 Mar 2016 08:45:51 +0000 (19:45 +1100)
committerBrendan Heywood <brendan@catalyst-au.net>
Mon, 14 Mar 2016 03:20:10 +0000 (14:20 +1100)
(Introduced by previous patch MDL-52818)

lib/tests/moodlelib_test.php

index e230e00..fb9d5ae 100644 (file)
@@ -2685,6 +2685,9 @@ class core_moodlelib_testcase extends advanced_testcase {
         }
     }
 
+    /**
+     * A data provider for testing email diversion
+     */
     public function diverted_emails_provider() {
         return array(
             'nodiverts' => array(
@@ -2737,7 +2740,14 @@ class core_moodlelib_testcase extends advanced_testcase {
     }
 
     /**
+     * Test email diversion
+     *
      * @dataProvider diverted_emails_provider
+     *
+     * @param string $divertallemailsto An optional email address
+     * @param string $divertallemailsexcept An optional exclusion list
+     * @param array $addresses An array of test addresses
+     * @param boolean $expected Expected result
      */
     public function test_email_should_be_diverted($divertallemailsto, $divertallemailsexcept, $addresses, $expected) {
         global $CFG;