Reduce local/moodlecheck errors.

Author: lucaboesch

action.php

@@ -27,7 +27,7 @@
  *
  * @package   mod_pdfannotator
  * @copyright 2018 RWTH Aachen (see README.md)
- * @authors   Rabea de Groot, Anna Heynkes, Friederike Schwager
+ * @author   Rabea de Groot, Anna Heynkes, Friederike Schwager
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

backup/moodle2/restore_pdfannotator_activity_task.class.php

@@ -81,9 +81,9 @@ static public 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
      * pdfannotator logs. It must return one array
-     * of {@link restore_log_rule} objects
+     * of {@see restore_log_rule} objects
      */
     static public function define_restore_log_rules() {
         $rules = array();
@@ -97,9 +97,9 @@ static public 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/output/answermenu.php

@@ -37,7 +37,6 @@ class answermenu implements \renderable, \templatable {
 
     /**
      * Constructor of renderable for dropdown menu in answerstable.
-     * @global type $CFG
      * @param int $annotationid Id of the annotation the answer belongs to
      * @param bool $issubscribed Is the user subscribed to the question?
      * @param int $cmid Course module id

classes/output/reportmenu.php

@@ -36,7 +36,6 @@ class reportmenu implements \renderable, \templatable {
 
     /**
      * Constructor of renderable for dropdown menu in reportstable.
-     * @global type $CFG
      * @param object $report Report object
      * @param int $cmid Course module id
      * @param int $currentpage Page of the table on overviewpage

classes/output/statistics.php

@@ -42,8 +42,6 @@ class statistics implements \renderable, \templatable {
 
     /**
      * Constructor of renderable for statistics tab.
-     * @global type $USER
-     * @global type $PAGE
      * @param int $annotatorid Id of the annotator
      * @param int $courseid ID of the course
      * @param object $capabilities Some of the capabilities the user has-

classes/privacy/provider.php

@@ -14,8 +14,10 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 /**
+ * Privacy class for requesting user data.
+ *
  * @package   mod_pdfannotator
- * @category  backup
+ * @category  privacy
  * @copyright 2018 RWTH Aachen (see README.md)
  * @author    Anna Heynkes
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -309,9 +311,9 @@ public static function delete_data_for_all_users_in_context(\context $context) {
 
     /**
      *
-     * @global type $DB
-     * @param \mod_pdfannotator\privacy\approved_contextlist $contextlist
-     * @return type
+     * Delete personal data for the user in a list of contexts.
+     *
+     * @param \mod_pdfannotator\privacy\approved_contextlist $contextlist List of contexts to delete data from.
      */
     public static function delete_data_for_user(approved_contextlist $contextlist) {
 
@@ -372,8 +374,7 @@ public static function delete_data_for_user(approved_contextlist $contextlist) {
     /**
      * Function deletes an annotation and all comments and subscriptions attached to it.
      *
-     * @global \mod_pdfannotator\privacy\type $DB
-     * @param type $annotationid
+     * @param int $annotationid One annotationid (int) to delete
      */
     public static function delete_annotation($annotationid) {
 
@@ -400,6 +401,13 @@ public static function delete_annotation($annotationid) {
         $DB->delete_records('pdfannotator_annotations', array("id" => $annotationid));
     }
 
+    /**
+     * Function empties or deletes a comment.
+     *
+     * @param \mod_pdfannotator\output\comment $comment comment to be emptied or deleted
+     *
+     * @throws \dml_exception
+     */
     public static function empty_or_delete_comment($comment) {
 
         global $DB;

constants.php

@@ -16,7 +16,7 @@
 /**
  * @package   mod_pdfannotator
  * @copyright 2018 RWTH Aachen (see README.md)
- * @authors   Rabea de Groot, Anna Heynkes, Friederike Schwager
+ * @author   Rabea de Groot, Anna Heynkes, Friederike Schwager
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

controller.php

@@ -17,7 +17,7 @@
 /**
  * @package   mod_pdfannotator
  * @copyright 2018 RWTH Aachen (see README.md)
- * @authors   Anna Heynkes, Friederike Schwager
+ * @author   Anna Heynkes, Friederike Schwager
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

db/access.php

@@ -17,7 +17,7 @@
 /**
  * @package   mod_pdfannotator
  * @copyright 2018 RWTH Aachen (see README.md)
- * @authors   Rabea de Groot and Anna Heynkes
+ * @author   Rabea de Groot and Anna Heynkes
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 defined('MOODLE_INTERNAL') || die();

db/install.php

@@ -22,7 +22,6 @@
 /**
  * Function initialises the pdfannotator_annotationtypes table with its 6 standard records.
  *
- * @global type $DB
  */
 defined('MOODLE_INTERNAL') || die();