MDL-30995 completion: Fixed up PHPdocs for activity completion

lib/completion/completion_aggregation.php

@@ -1,5 +1,4 @@
 <?php
-
 // This file is part of Moodle - http://moodle.org/
 //
 // Moodle is free software: you can redistribute it and/or modify
@@ -19,65 +18,70 @@
 /**
  * Course completion critieria aggregation
  *
- * @package   moodlecore
+ * @package core_completion
+ * @category completion
  * @copyright 2009 Catalyst IT Ltd
- * @author    Aaron Barnes <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author Aaron Barnes <[email protected]>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+
+defined('MOODLE_INTERNAL') || die();
 require_once($CFG->libdir.'/completion/data_object.php');
 
 /**
  * Course completion critieria aggregation
+ *
+ * @package core_completion
+ * @category completion
+ * @copyright 2009 Catalyst IT Ltd
+ * @author Aaron Barnes <[email protected]>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class completion_aggregation extends data_object {
 
     /**
-     * DB Table
-     * @var string $table
+     * Database table name that stores completion aggregation information
+     * @var string
      */
     public $table = 'course_completion_aggr_methd';
 
     /**
      * Array of required table fields, must start with 'id'.
-     * @var array $required_fields
+     * Defaults to id, course, criteriatype, method, value
+     * @var array
      */
     public $required_fields = array('id', 'course', 'criteriatype', 'method', 'value');
 
     /**
      * Course id
-     * @access  public
-     * @var     int
+     * @var int
      */
     public $course;
 
     /**
      * Criteria type this aggregation method applies to, or NULL for overall course aggregation
-     * @access  public
-     * @var     int
+     * @var int
      */
     public $criteriatype;
 
     /**
      * Aggregation method (COMPLETION_AGGREGATION_* constant)
-     * @access  public
-     * @var     int
+     * @var int
      */
     public $method;
 
     /**
      * Method value
-     * @access  public
-     * @var     mixed
+     * @var mixed
      */
     public $value;
 
 
     /**
      * Finds and returns a data_object instance based on params.
-     * @static abstract
      *
      * @param array $params associative arrays varname=>value
-     * @return object data_object instance or false if none found.
+     * @return data_object instance of data_object or false if none found.
      */
     public static function fetch($params) {
         return self::fetch_helper('course_completion_aggr_methd', __CLASS__, $params);
@@ -86,7 +90,6 @@ class completion_aggregation extends data_object {
 
     /**
      * Finds and returns all data_object instances based on params.
-     * @static abstract
      *
      * @param array $params associative arrays varname=>value
      * @return array array of data_object insatnces or false if none found.
@@ -95,9 +98,8 @@ class completion_aggregation extends data_object {
 
     /**
      * Set the aggregation method
-     * @access  public
-     * @param   $method     int
-     * @return  void
+     *
+     * @param int $method One of COMPLETION_AGGREGATION_ALL or COMPLETION_AGGREGATION_ANY
      */
     public function setMethod($method) {
         $methods = array(
@@ -111,4 +113,4 @@ class completion_aggregation extends data_object {
             $this->method = COMPLETION_AGGREGATION_ALL;
         }
     }
-}
+}