Annotation improvements.

bfh · Sep 25, 2023 · 1ae083d · 1ae083d
1 parent ab07b4c
commit 1ae083d
Show file tree

Hide file tree

Showing 18 changed files with 36 additions and 94 deletions.
diff --git a/classes/model/instance.php b/classes/model/instance.php
@@ -35,9 +35,7 @@ class instance {
      * @var int The id.
      */
     public $id;
-    /**
-     * @var int The template id.
-     */
+    /** @var int The template id */
     public $templateid;
     /**
      * @var int  The course id.

diff --git a/classes/model/instance_category.php b/classes/model/instance_category.php
@@ -52,7 +52,7 @@ class instance_category {
      *
      * @param int $id The instance category id
      * @param int|null $paramtemplatecategoryid The parametrized template category id
-     * @param int $position The category position
+     * @param int $position The template category position
      * @param float $weight The category weight
      */
     public function __construct(int $id = 0, ?int $paramtemplatecategoryid = null, int $position = 0, float $weight = 0.0) {

diff --git a/classes/model/instance_criterion.php b/classes/model/instance_criterion.php
@@ -50,7 +50,7 @@ class instance_criterion {
      *
      * @param int $id The id
      * @param int|null $parametrizedtemplatecriterionid The parametrized template criterion id
-     * @param int $position The criterion position
+     * @param int $position The instance criterion position
      * @param float $weight The criterion weight
      * @param array $descriptions The criterion descriptions
      * @param array $subratings The criterion subratings

diff --git a/classes/model/template/parametrized_template_category.php b/classes/model/template/parametrized_template_category.php
@@ -43,7 +43,7 @@ class parametrized_template_category {
      * The parametrized template category model constructor
      * @param int $id The id
      * @param int $categoryid The category id
-     * @param int $position The position
+     * @param int $position The parametrized template category position
      * @param float $weight The weight
      */
     public function __construct(int $id = 0, int $categoryid = 0, int $position = 0, float $weight = 0.0) {

diff --git a/classes/model/template/parametrized_template_criterion.php b/classes/model/template/parametrized_template_criterion.php
@@ -29,7 +29,6 @@
 /**
  * The parametrized template criterion class
  */
-#[AllowDynamicProperties]
 class parametrized_template_criterion {
     /** @var int The id */
     public $id;
@@ -45,7 +44,7 @@ class parametrized_template_criterion {
      *
      * @param int $id The id
      * @param int $criterionid The parametrized template criterion id
-     * @param int $position The position
+     * @param int $position The parametrized template criterion position
      * @param float $weight The weight
      */
     public function __construct(int $id = 0, int $criterionid = 0, int $position = 0, float $weight = 0.0) {

diff --git a/classes/repository/model/db_instance.php b/classes/repository/model/db_instance.php
@@ -29,17 +29,11 @@
  * The database instance class
  */
 class db_instance {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
-    /**
-     * @var
-     */
+    /** @var int The template id */
     public $templateid;
-    /**
-     * @var
-     */
+    /** @var string The name */
     public $name;
     /**
      * @var

diff --git a/classes/repository/model/db_instance_category.php b/classes/repository/model/db_instance_category.php
@@ -29,9 +29,7 @@
  * The database instance category class
  */
 class db_instance_category {
-    /**
-     * @var
-     */
+    /** @var int The id */
     public $id;
     /**
      * @var
@@ -41,13 +39,9 @@ class db_instance_category {
      * @var
      */
     public $paramtemplatecategoryid;
-    /**
-     * @var
-     */
+    /** @var int The position */
     public $position;
-    /**
-     * @var
-     */
+    /** @var float The weight */
     public $weight;
 
     /**

diff --git a/classes/repository/model/db_instance_criterion.php b/classes/repository/model/db_instance_criterion.php
@@ -29,25 +29,17 @@
  * The database instance criterion class
  */
 class db_instance_criterion {
-    /**
-     * @var
-     */
+    /** @var int The id */
     public $id;
     /**
      * @var
      */
     public $paramtemplatecriterionid;
-    /**
-     * @var
-     */
+    /** @var int The category id */
     public $categoryid;
-    /**
-     * @var
-     */
+    /** @var int The position */
     public $position;
-    /**
-     * @var
-     */
+    /** @var float The weight */
     public $weight;
 
     /**

diff --git a/classes/repository/model/db_language.php b/classes/repository/model/db_language.php
@@ -29,9 +29,7 @@
  * The database language class
  */
 class db_language {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
     /**
      * @var

diff --git a/classes/repository/model/db_localized_string.php b/classes/repository/model/db_localized_string.php
@@ -29,9 +29,7 @@
  * The database localized string class
  */
 class db_localized_string {
-    /**
-     * @var int The id
-     */
+    /** @var int The id */
     public $id;
     /**
      * @var string The type

diff --git a/classes/repository/model/db_parametrized_category.php b/classes/repository/model/db_parametrized_category.php
@@ -29,32 +29,22 @@
  * The database parametrized category class
  */
 class db_parametrized_category {
-    /**
-     * @var
-     */
+    /** @var int The id */
     public $id;
-    /**
-     * @var
-     */
+    /** @var int The template id */
     public $templateid;
-    /**
-     * @var
-     */
+    /** @var int The parametrized template category id */
     public $categoryid;
-    /**
-     * @var
-     */
+    /** @var int The position */
     public $position;
-    /**
-     * @var
-     */
+    /** @var float The weight */
     public $weight;
 
     /**
      * Return a parametrized template category database object
      *
      * @param parametrized_template_category $category
-     * @param int $templateid
+     * @param int $templateid The parametrized template category id
      * @return db_parametrized_category
      */
     public static function from_parametrized_category(parametrized_template_category $category, int $templateid) {

diff --git a/classes/repository/model/db_parametrized_criterion.php b/classes/repository/model/db_parametrized_criterion.php
@@ -28,21 +28,16 @@
 /**
  * The database parametrized criterion class
  */
-#[AllowDynamicProperties]
 class db_parametrized_criterion {
-    /**
-     * @var
-     */
+    /** @var int The id */
+    public $id;
+    /** @var int The category id */
     public $categoryid;
     /** @var int The criterion id */
     public $criterionid;
-    /**
-     * @var
-     */
+    /** @var int The position */
     public $position;
-    /**
-     * @var
-     */
+    /** @var float The weight */
     public $weight;
 
     /**

diff --git a/classes/repository/model/db_response.php b/classes/repository/model/db_response.php
@@ -29,9 +29,7 @@
  * The database response class
  */
 class db_response {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
     /**
      * @var

diff --git a/classes/repository/model/db_submission.php b/classes/repository/model/db_submission.php
@@ -29,9 +29,7 @@
  * The database submission class
  */
 class db_submission {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
     /**
      * @var

diff --git a/classes/repository/model/db_subrating.php b/classes/repository/model/db_subrating.php
@@ -29,9 +29,7 @@
  * The database subrating class
  */
 class db_subrating {
-    /**
-     * @var int The id
-     */
+    /** @var int The id */
     public $id = 0;
     /** @var int The criterion id */
     public $criterionid;

diff --git a/classes/repository/model/db_template.php b/classes/repository/model/db_template.php
@@ -29,17 +29,11 @@
  * The database template class
  */
 class db_template {
-    /**
-     * @var int The id
-     */
+    /** @var int The id */
     public $id = 0;
-    /**
-     * @var string The name
-     */
+    /** @var string The name */
     public $name;
-    /**
-     * @var string The description
-     */
+    /** @var string The description */
     public $description;
 
     /**

diff --git a/classes/repository/model/db_template_category.php b/classes/repository/model/db_template_category.php
@@ -29,9 +29,7 @@
  * The database template category class
  */
 class db_template_category {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
     /**
      * @var

diff --git a/classes/repository/model/db_template_criterion.php b/classes/repository/model/db_template_criterion.php
@@ -29,9 +29,7 @@
  * The database template criterion class
  */
 class db_template_criterion {
-    /**
-     * @var int
-     */
+    /** @var int The id */
     public $id = 0;
     /**
      * @var string