[#272] Make code checker and phpdoc happy

Add @param description
catalyst · Sep 5, 2023 · a8884c3 · a8884c3
1 parent 1289c47
commit a8884c3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/classes/script_metadata.php b/classes/script_metadata.php
@@ -226,9 +226,9 @@ public static function get_request(): string {
 
     /**
      * Gets the name of the script.
-     * Parameters are share the names of globals as a hint to the caller.
-     * @param string $ME
-     * @param string $SCRIPT
+     * Parameters share the names of globals as a hint to the caller.
+     * @param ?string $ME This should be the $ME global.
+     * @param ?string $SCRIPT This should be the $SCRIPT global.
      * @return string the request path for this profile.
      */
     public static function get_normalised_relative_script_path(?string $ME, ?string $SCRIPT): string {

diff --git a/tests/tool_excimer_script_metadata_test.php b/tests/tool_excimer_script_metadata_test.php
@@ -192,6 +192,9 @@ public function sampling_limit_provider(): array {
      * Tests script_metadata::get_request().
      * @dataProvider normalised_relative_script_path_provider
      * @covers \tool_excimer\script_metadata::get_request
+     * @param string $path
+     * @param string $oldexpected
+     * @param string $newexpected
      */
     public function test_get_request(string $path, string $oldexpected, string $newexpected) {
         script_metadata::init();
@@ -213,8 +216,9 @@ public function test_get_request(string $path, string $oldexpected, string $newe
      * Tests script_metadata::get_normalised_relative_script_path().
      * @dataProvider normalised_relative_script_path_provider
      * @covers \tool_excimer\script_metadata::get_normalised_relative_script_path
-     * @param string $pathinfo
-     * @param string $expected
+     * @param string $path
+     * @param string $oldexpected
+     * @param string $newexpected
      */
     public function test_get_normalised_relative_script_path(string $path, string $oldexpected, string $newexpected) {
         script_metadata::init();
@@ -224,7 +228,7 @@ public function test_get_normalised_relative_script_path(string $path, string $o
 
     /**
      * Provider for test_get_normalised_relative_script_path().
-     * @return \string[][]
+     * @return array[]
      */
     public function normalised_relative_script_path_provider(): array {
         return [