Fix PHP documentation errors

Author: dlmsr

classes/local/clients/user_folder_access.php

@@ -123,8 +123,8 @@ protected function get_user_oauth_client($oauthloginreturnurl) {
     /**
      * A method, which attempts to rename a given, privately shared, folder.
      *
-     * @param $pathtofolder string path, which leads to the folder that needs to be renamed.
-     * @param $newname string the name which needs to be set instead of the old.
+     * @param string $pathtofolder path, which leads to the folder that needs to be renamed.
+     * @param string $newname the name which needs to be set instead of the old.
      * @return array contains status (true means success, false failure) and content (generated
      *              link or error message) of the result.
      */
@@ -196,10 +196,10 @@ public function check_login(): bool {
      * database table. If the specific record already exists, it gets updated in the concerning field. Otherwise,
      * a new record is inserted into the table.
      *
-     * @param $cmid int ID of the course module. Needed to specify the concrete activity instance.
-     * @param $groupid int the group ID to specify one particular folder.
-     * @param $userid string ID of the user, which the value needs to be set for.
-     * @param $value string the specific value, which needs to be set or updated.
+     * @param int $cmid ID of the course module. Needed to specify the concrete activity instance.
+     * @param int $groupid  the group ID to specify one particular folder.
+     * @param string $userid ID of the user, which the value needs to be set for.
+     * @param string $value the specific value, which needs to be set or updated.
      */
     public function store_link($cmid, $groupid, $userid, $value) {
         // TODO use persistent API instead.
@@ -231,9 +231,9 @@ public function store_link($cmid, $groupid, $userid, $value) {
      * database table. It is used to get a stored folder name or link for a specific user and course
      * module.
      *
-     * @param $cmid int the course module ID. Needed to specify the concrete activity instance.
-     * @param $groupid int the group ID to specify one particular folder.
-     * @param $userid string ID of the user, which the value needs to be gotten for.
+     * @param int $cmid the course module ID. Needed to specify the concrete activity instance.
+     * @param int $groupid the group ID to specify one particular folder.
+     * @param string $userid ID of the user, which the value needs to be gotten for.
      * @return object|false
      */
     public function get_link($cmid, $groupid, $userid) {

classes/output/renderer.php

@@ -113,6 +113,8 @@ public function render_widget_misconfiguration() {
 
     /**
      * Render problem_sharessuppressed notification.
+     * @param int $sharessuppressed sharesuppressed option
+     * @return string
      */
     public function render_widget_noconnection_suppressed_share(int $sharessuppressed) {
         $info = (object)[
@@ -130,7 +132,8 @@ public function render_widget_noconnection_suppressed_share(int $sharessuppresse
 
     /**
      * Render the name form.
-     * @param name_form $form
+     * @param \stdClass $group group record
+     * @param name_form $form the name form
      */
     public function output_name_form($group, name_form $form) {
         if ($group->id !== \mod_collaborativefolders\toolbox::fake_course_group('')->id) {
@@ -152,8 +155,8 @@ public function output_name_form($group, name_form $form) {
      * @param stdClass $group Group object containing ID and name
      * @param int $cmid Course module ID
      * @param string $foldername Chosen (and assumed) name of the folder
-     * @param string $link Link into ownCloud instance
-     * @param string $warning (optional) warning message to display beside folder details
+     * @param string $folderlink Link into ownCloud instance
+     * @param string|null $warning (optional) warning message to display beside folder details
      * @return bool|string rendered template.
      */
     public function output_shared_folder($group, $cmid, $foldername, $folderlink, $warning = null) {

classes/view_controller.php

@@ -176,10 +176,10 @@ private static function get_instance_status($collaborativefolder, \cm_info $cm,
      * # Defining a user-local name and generating a share
      * # Display the selected name, a link, and a button for problem solving (aka re-share).
      *
-     * @param \cm_info $cmid Course module info
-     * @param array $folderforms
-     * @param statusinfo $statusinfo
-     * @param mod_collaborativefolders\output\renderer $renderer
+     * @param cm_info $cm Course module info
+     * @param array $folderforms list of folder forms
+     * @param statusinfo $statusinfo status information
+     * @param mod_collaborativefolders\output\renderer $renderer plugin renderer
      * @param bool $isteacher true if the viewing user is a teacher
      * @param bool $systemclientcanshare true if there is a connected system account that could create a share
      * @param user_folder_access $userclient connected client for the current user.
@@ -289,7 +289,6 @@ private static function obtain_folders(statusinfo $statusinfo, \cm_info $cm, boo
      * @param \cm_info $cm current coursemodule
      * @param user_folder_access $userclient connected client of the user
      * @param system_folder_access $systemclient connected system client
-     * @param int|Name $currentuserid Name of the user that the form will be shared with
      * @param \context_module $context context of the current coursemodule
      */
     public static function handle_folder_form_submitted(

lib.php

@@ -29,8 +29,6 @@
 /**
  * Returns the information on whether the module supports a feature.
  *
- * See {@link plugin_supports()} for more info.
- *
  * @param string $feature FEATURE_xx constant for requested feature
  * @return mixed true if the feature is supported, null if unknown
  */

tests/events_test.php

@@ -116,7 +116,7 @@ public function test_link_generated(): void {
     /**
      * Helper method to fetch the results from a triggered event.
      *
-     * @param $event \core\event\base event, which needs to be triggered.
+     * @param \core\event\base $event event, which needs to be triggered.
      * @return \core\event\base|mixed the caught event data.
      */
     protected function get_event_result($event) {

tests/generator/lib.php

@@ -42,8 +42,8 @@ public function create_test_issuer(string $name): \core\oauth2\issuer {
 
     /**
      * Creates Course, course members, groups and groupings to test the module.
-     * @param $groupmode
-     * @param $grouping
+     * @param int $groupmode the group mode
+     * @param int $grouping the grouping id
      * @return array
      * @throws coding_exception
      */