standardized PHPDocs package info

roddle · Sep 6, 2010 · 5d354de · 5d354de
1 parent 844239d
commit 5d354de
Show file tree

Hide file tree

Showing 22 changed files with 51 additions and 47 deletions.
diff --git a/admin/roles/admins.php b/admin/roles/admins.php
@@ -18,7 +18,7 @@
 /**
  * Lets you site administrators
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  2010 Petr Skoda (skodak) http://skodak.org
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/allow.php b/admin/roles/allow.php
@@ -18,7 +18,7 @@
 /**
  * Allow overriding of roles by other roles
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/assign.php b/admin/roles/assign.php
@@ -18,7 +18,7 @@
 /**
  * Lets you assign roles to users in a particular context.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/check.php b/admin/roles/check.php
@@ -18,7 +18,7 @@
 /**
  * Shows the result of has_capability for every capability for a user in a context.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/define.php b/admin/roles/define.php
@@ -24,7 +24,7 @@
  *   edit      - edit the definition of a role
  *   view      - view the definition of a role
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/lib.php b/admin/roles/lib.php
@@ -24,7 +24,7 @@
  *   edit      - edit the definition of a role
  *   view      - view the definition of a role
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/manage.php b/admin/roles/manage.php
@@ -28,7 +28,7 @@
  * For all but the first two of those, you also need a roleid parameter, and
  * possibly some other data.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/managetabs.php b/admin/roles/managetabs.php
@@ -18,7 +18,7 @@
 /**
  * Defines the tab bar used on the manage/allow assign/allow overrides pages.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/override.php b/admin/roles/override.php
@@ -18,7 +18,7 @@
 /**
  * Lets you override role definitions in contexts.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/permissions.php b/admin/roles/permissions.php
@@ -18,7 +18,7 @@
 /**
  * This script serves draft files of current user
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  2009 Petr Skoda (skodak) [email protected]
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/permissions_forms.php b/admin/roles/permissions_forms.php
@@ -18,7 +18,7 @@
 /**
  * This script serves draft files of current user
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  2009 Petr Skoda (skodak) [email protected]
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/admin/roles/usersroles.php b/admin/roles/usersroles.php
@@ -19,7 +19,7 @@
  * User roles report list all the users who have been assigned a particular
  * role in all contexts.
  *
- * @package    moodlecore
+ * @package    core
  * @subpackage role
  * @copyright  &copy; 2007 The Open University and others
  * @author     [email protected] and others

diff --git a/rating/index.php b/rating/index.php
@@ -18,9 +18,10 @@
 /**
  * A page to display a list of ratings for a given item (forum post etc)
  *
- * @package   moodlecore
- * @copyright 2010 Andrew Davis
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    core
+ * @subpackage rating
+ * @copyright  2010 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once("../config.php");
@@ -97,7 +98,7 @@
         //we could clone the rating object or preserve the rating id if we needed it again
         //but we don't
         $rating->id = $rating->uid;
-        
+
         echo '<tr class="ratingitemheader">';
         echo "<td>";
         if($course && $course->id) {

diff --git a/rating/lib.php b/rating/lib.php
@@ -18,9 +18,10 @@
 /**
  * A class representing a single rating and containing some static methods for manipulating ratings
  *
- * @package   moodlecore
- * @copyright 2010 Andrew Davis
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    core
+ * @subpackage rating
+ * @copyright  2010 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 define('RATING_UNSET_RATING', -999);
@@ -386,7 +387,7 @@ public function get_ratings($options) {
                     $rating->count      = $rec->numratings; //unset($rec->numratings);
                     $rating->rating     = $rec->usersrating; //unset($rec->usersrating);
                     $rating->itemtimecreated = $this->get_item_time_created($item);
-                    
+
                     break;
                 }
             }
@@ -492,7 +493,7 @@ public function get_user_grades($options) {
         $params['contextid']= $contextid;
         $itemtable          = $options->itemtable;
         $itemtableusercolumn= $options->itemtableusercolumn;
-        $scaleid            = $options->scaleid;        
+        $scaleid            = $options->scaleid;
         $aggregationstring = $this->get_aggregation_method($options->aggregationmethod);
 
         //if userid is not 0 we only want the grade for a single user

diff --git a/rating/rate.php b/rating/rate.php
@@ -20,9 +20,10 @@
  *
  * It is similar to rate_ajax.php. Unlike rate_ajax.php a return url is required.
  *
- * @package   moodlecore
- * @copyright 2010 Andrew Davis
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    core
+ * @subpackage rating
+ * @copyright  2010 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once('../config.php');

diff --git a/rating/rate_ajax.php b/rating/rate_ajax.php
@@ -20,9 +20,10 @@
  *
  * It is similar to rate.php. Unlike rate.php a return url is NOT required.
  *
- * @package   moodlecore
- * @copyright 2010 Andrew Davis
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package    core
+ * @subpackage rating
+ * @copyright  2010 Andrew Davis
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 define('AJAX_SCRIPT', true);
@@ -99,7 +100,7 @@
     $options->contextid = $context->id;
     $options->userid = $USER->id;
     $options->itemid = $itemid;
-    
+
     $rm->delete_ratings($options);
 }
 
@@ -156,7 +157,7 @@
 //if we accept the item owner user id from the http request a user could alter the URL and erroneously get access to the rating aggregate
 
 //if its their own item and they have view permission
-if (($USER->id==$items[0]->rating->itemuserid && has_capability('moodle/rating:view',$context) 
+if (($USER->id==$items[0]->rating->itemuserid && has_capability('moodle/rating:view',$context)
         && (empty($pluginpermissionsarray) or $pluginpermissionsarray['view']))
     //or if its not their item or if no user created the item (the hub did) and they have viewany permission
     || (($USER->id!=$items[0]->rating->itemuserid or empty($items[0]->rating->itemuserid)) && has_capability('moodle/rating:viewany',$context)

diff --git a/repository/draftfiles_manager.php b/repository/draftfiles_manager.php
@@ -26,10 +26,10 @@
  * This file is used to manage draft files in non-javascript browsers
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2010 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2010 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once('../config.php');

diff --git a/repository/filepicker.php b/repository/filepicker.php
@@ -20,10 +20,10 @@
  * This file is used to browse repositories in non-javascript mode
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2009 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once('../config.php');

diff --git a/repository/lib.php b/repository/lib.php
@@ -21,10 +21,10 @@
  * and was introduced as part of the changes occuring in Moodle 2.0
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2009 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once(dirname(dirname(__FILE__)) . '/config.php');

diff --git a/repository/manage_instances.php b/repository/manage_instances.php
@@ -20,10 +20,10 @@
  * This file is used to manage repositories
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2009 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once(dirname(dirname(__FILE__)) . '/config.php');

diff --git a/repository/repository_ajax.php b/repository/repository_ajax.php
@@ -20,10 +20,10 @@
  * The Web service script that is called from the filepicker front end
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2009 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 define('AJAX_SCRIPT', true);

diff --git a/repository/repository_callback.php b/repository/repository_callback.php
@@ -20,10 +20,10 @@
  * Repository instance callback script
  *
  * @since 2.0
- * @package moodlecore
+ * @package    core
  * @subpackage repository
- * @copyright 2009 Dongsheng Cai <[email protected]>
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright  2009 Dongsheng Cai <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
 require_once(dirname(dirname(__FILE__)).'/config.php');