Fix Moodle documentation errors.

Author: lucaboesch

backup/moodle2/backup_ratingallocate_activity_task.class.php

@@ -46,6 +46,8 @@ protected function define_my_steps() {
     /**
      * Code the transformations to perform in the activity in
      * order to get transportable (encoded) links
+     *
+     * @param array $content
      */
     public static function encode_content_links($content) {
         return $content;

backup/moodle2/backup_restore_helper.php

@@ -26,7 +26,7 @@
 /**
  * Get fields for tableclass
  *
- * @param $class
+ * @param \stdClass $class
  * @return array
  * @throws ReflectionException
  */
@@ -45,7 +45,7 @@ function get_fields_for_tableclass($class) {
 /**
  * Get tablename for tableclass.
  *
- * @param $class
+ * @param \stdClass $class
  * @return mixed
  * @throws ReflectionException
  */
@@ -58,7 +58,7 @@ function get_tablename_for_tableclass($class) {
 /**
  * Get id for tableclass.
  *
- * @param $class
+ * @param \stdClass $class
  * @return array
  * @throws ReflectionException
  */

backup/moodle2/restore_ratingallocate_activity_stepslib.php

@@ -60,7 +60,7 @@ protected function define_structure() {
     /**
      * Process ratingallocate.
      *
-     * @param $data
+     * @param array $data
      * @return void
      * @throws base_step_exception
      * @throws dml_exception
@@ -89,7 +89,7 @@ protected function process_ratingallocate($data) {
 
     /**
      * Restore data for ratingallocate choices.
-     * @param $data
+     * @param array $data
      * @return void
      * @throws dml_exception
      * @throws restore_step_exception
@@ -108,7 +108,7 @@ protected function process_ratingallocate_choices($data) {
 
     /**
      * Restore data for the ratingallocate ratings of users.
-     * @param $data
+     * @param array $data
      * @return void
      * @throws dml_exception
      * @throws restore_step_exception
@@ -128,7 +128,7 @@ protected function process_ratingallocate_ratings($data) {
 
     /**
      * Restore data of allocations of users to choices.
-     * @param $data
+     * @param array $data
      * @return void
      * @throws dml_exception
      * @throws restore_step_exception
@@ -167,7 +167,7 @@ protected function process_ratingallocate_group_choices($data) {
 
     /**
      * Restore data for generated groups based on allocations.
-     * @param $data
+     * @param array $data
      * @return void
      * @throws dml_exception
      * @throws restore_step_exception
@@ -186,7 +186,7 @@ protected function process_ratingallocate_ch_gengroups($data) {
 
     /**
      * Restore data for generated groupings based on allocations.
-     * @param $data
+     * @param array $data
      * @return void
      * @throws dml_exception
      * @throws restore_step_exception

backup/moodle2/restore_ratingallocate_activity_task.class.php

@@ -73,10 +73,10 @@ public static function define_decode_rules() {
 
     /**
      * Define the restore log rules that will be applied
-     * by the {@link restore_logs_processor} when restoring
+     * by the {@see restore_logs_processor} when restoring
      * ratingallocate logs.
      * It must return one array
-     * of {@link restore_log_rule} objects
+     * of {@see restore_log_rule} objects
      */
     public static function define_restore_log_rules() {
         $rules = [];
@@ -86,10 +86,10 @@ public static function define_restore_log_rules() {
 
     /**
      * Define the restore log rules that will be applied
-     * by the {@link restore_logs_processor} when restoring
+     * by the {@see restore_logs_processor} when restoring
      * course logs.
      * It must return one array
-     * of {@link restore_log_rule} objects
+     * of {@see restore_log_rule} objects
      *
      * Note this rules are applied when restoring course logs
      * by the restore final task, but are defined here at

classes/allocations_table.php

@@ -200,7 +200,7 @@ public function build_table_by_sql() {
 
     /**
      * Returns a link to a user profile labeled with the full name of the user.
-     * @param $user \stdClass user object.
+     * @param \stdClass $user user object.
      * @return string HTML code representing the link to the users profile.
      */
     private function get_user_link($user) {

classes/choice_importer.php

@@ -82,8 +82,8 @@ public static function print_fields($fields=self::REQUIRED_FIELDS) {
     /**
      * Construct.
      *
-     * @param $ratingallocateid
-     * @param $ratingallocate
+     * @param int $ratingallocateid
+     * @param \ratingallocate $ratingallocate
      */
     public function __construct($ratingallocateid, $ratingallocate) {
         $this->ratingallocate = $ratingallocate;

classes/event/all_ratings_deleted.php

@@ -33,8 +33,9 @@ class all_ratings_deleted extends \core\event\base {
 
     /**
      * Create simple all_ratings_deleted event.
-     * @param $modulecontext
-     * @param $ratingallocateid
+     *
+     * @param \stdClass $modulecontext
+     * @param int $ratingallocateid
      * @return \core\event\base
      * @throws \coding_exception
      */

classes/event/allocation_published.php

@@ -41,8 +41,9 @@ class allocation_published extends \core\event\base {
 
     /**
      * Create simple allocation_published event.
-     * @param $modulecontext
-     * @param $ratingallocateid
+     *
+     * @param \stdClass $modulecontext
+     * @param int $ratingallocateid
      * @return \core\event\base
      * @throws \coding_exception
      */

classes/event/allocation_statistics_viewed.php

@@ -35,8 +35,9 @@ class allocation_statistics_viewed extends \core\event\base {
 
     /**
      * Create simple allocation_statistics_viewed event.
-     * @param $modulecontext
-     * @param $ratingallocateid
+     *
+     * @param \stdClass $modulecontext
+     * @param int $ratingallocateid
      * @return \core\event\base
      * @throws \coding_exception
      */

classes/event/allocation_table_viewed.php

@@ -35,8 +35,9 @@ class allocation_table_viewed extends \core\event\base {
 
     /**
      * Create simple allocation_table_viewed event.
-     * @param $modulecontext
-     * @param $ratingallocateid
+     *
+     * @param \stdClass $modulecontext
+     * @param int $ratingallocateid
      * @return \core\event\base
      * @throws \coding_exception
      */