Fix phpdocs.

diff --git a/classes/task/auto_mark.php b/classes/task/auto_mark.php
index 54a6f7b..40be6d5 100644 (file)
--- a/classes/task/auto_mark.php
+++ b/classes/task/auto_mark.php
@@ -34,10 +34,19 @@ require_once($CFG->dirroot . '/mod/attendance/locallib.php');
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class auto_mark extends \core\task\scheduled_task {
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
     public function get_name() {
         // Shown in admin screens.
         return get_string('automarktask', 'mod_attendance');
     }
+
+    /**
+     * Execte the task.
+     */
     public function execute() {
         global $DB;
         // Create some cache vars - might be nice to restructure this and make a smaller number of sql calls.

diff --git a/classes/task/notify.php b/classes/task/notify.php
index 138097c..5584307 100644 (file)
--- a/classes/task/notify.php
+++ b/classes/task/notify.php
@@ -34,10 +34,19 @@ require_once($CFG->dirroot . '/mod/attendance/locallib.php');
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class notify extends \core\task\scheduled_task {
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
     public function get_name() {
         // Shown in admin screens.
         return get_string('notifytask', 'mod_attendance');
     }
+
+    /**
+     * Execute the task.
+     */
     public function execute() {
         global $DB;
         if (empty(get_config('attendance', 'enablewarnings'))) {

diff --git a/locallib.php b/locallib.php
index dfb3c92..3d40c11 100644 (file)
--- a/locallib.php
+++ b/locallib.php
@@ -524,7 +524,7 @@ function attendance_exporttocsv($data, $filename) {
 /**
  * Get session data for form.
  * @param stdClass $formdata moodleform - attendance form.
- * $param mod_attendance_structure $att - used to get attendance level subnet.
+ * @param mod_attendance_structure $att - used to get attendance level subnet.
  * @return array.
  */
 function attendance_construct_sessions_data_for_add($formdata, mod_attendance_structure $att) {
@@ -716,6 +716,7 @@ SELECT a.id, a.course as courseid, c.fullname as coursename, atl.studentid AS us
  * Generates a list of users flagged absent.
  *
  * @param array $courseids optional list of courses to return
+ * @param string $orderby how to order results.
  * @param bool $allfornotify get notification list for scheduled task.
  * @return stdClass
  */

diff --git a/password.php b/password.php
index 041d618..f368126 100644 (file)
--- a/password.php
+++ b/password.php
@@ -20,8 +20,8 @@
  * Use {@link core_renderer::help_icon()} or {@link addHelpButton()} to display
  * the help icon.
  *
- * @copyright 2002 onwards Martin Dougiamas
- * @package   core
+ * @copyright  2017 Dan Marsden
+ * @package    mod_attendance
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 

diff --git a/password_ajax.php b/password_ajax.php
index 4faf694..0930612 100644 (file)
--- a/password_ajax.php
+++ b/password_ajax.php
@@ -20,8 +20,8 @@
  * Use {@link core_renderer::help_icon()} or {@link addHelpButton()} to display
  * the help icon.
  *
- * @copyright 2002 onwards Martin Dougiamas
- * @package   core
+ * @copyright  2017 Dan Marsden
+ * @package    mod_attendance
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 define('AJAX_SCRIPT', true);

diff --git a/renderables.php b/renderables.php
index 0b546e0..4df97f1 100644 (file)
--- a/renderables.php
+++ b/renderables.php
@@ -812,7 +812,6 @@ class url_helpers {
 
 /**
  * Data structure representing an attendance password icon.
- * copied from help_icon class
  *
  * @copyright 2017 Dan Marsden
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
@@ -835,7 +834,7 @@ class attendance_password_icon implements renderable, templatable {
      * @param string $identifier string for help page title,
      *  string with _help suffix is used for the actual help text.
      *  string with _link suffix is used to create a link to further info (if it exists)
-     * @param string $component
+     * @param string $sessionid
      */
     public function __construct($text, $sessionid) {
         $this->text  = $text;

diff --git a/renderer.php b/renderer.php
index 7b382e7..93a19a4 100644 (file)
--- a/renderer.php
+++ b/renderer.php
@@ -296,7 +296,7 @@ class mod_attendance_renderer extends plugin_renderer_base {
     /**
      * Implementation of user image rendering.
      *
-     * @param help_icon $helpicon A help icon instance
+     * @param attendance_password_icon $helpicon A help icon instance
      * @return string HTML fragment
      */
     protected function render_attendance_password_icon(attendance_password_icon $helpicon) {