MDL-39386 fix phpdocs packages in enrol

abgreeve · Apr 27, 2013 · 31ac2ae · 31ac2ae
1 parent cf5a329
commit 31ac2ae
Show file tree

Hide file tree

Showing 74 changed files with 99 additions and 201 deletions.
diff --git a/enrol/ajax.php b/enrol/ajax.php
@@ -20,8 +20,7 @@
  * The general idea behind this file is that any errors should throw exceptions
  * which will be returned and acted upon by the calling AJAX script.
  *
- * @package    core
- * @subpackage enrol
+ * @package    core_enrol
  * @copyright  2010 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/authorize/authorizenet.class.php b/enrol/authorize/authorizenet.class.php
@@ -19,8 +19,7 @@
  *
  * This plugin allows you to set up paid courses, using authorize.net.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/db/upgrade.php b/enrol/authorize/db/upgrade.php
@@ -1,24 +1,27 @@
 <?php
-
-// This file keeps track of upgrades to
-// the authorize enrol plugin
-//
-// Sometimes, changes between versions involve
-// alterations to database structures and other
-// major things that may break installations.
-//
-// The upgrade function in this file will attempt
-// to perform all the necessary actions to upgrade
-// your older installation to the current version.
+// This file is part of Moodle - http://moodle.org/
 //
-// If there's something it cannot do itself, it
-// will tell you what you need to do.
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
 //
-// The commands in here will all be database-neutral,
-// using the methods of database_manager class
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
 //
-// Please do not forget to use upgrade_set_timeout()
-// before any action that may take longer time to finish.
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Authorize.Net enrolment plugin upgrades.
+ *
+ * @package    enrol_authorize
+ * @copyright  2006 Eugene Venter
+ * @author     Eugene Venter
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 function xmldb_enrol_authorize_upgrade($oldversion) {
     global $CFG, $DB;

diff --git a/enrol/authorize/enrol_form.php b/enrol/authorize/enrol_form.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
@@ -18,8 +17,7 @@
 /**
  * Authorize.Net enrol plugin implementation.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/import_form.php b/enrol/authorize/import_form.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,8 +18,7 @@
  * Adds new instance of enrol_authorize to specified course
  * or edits current instance.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/index.php b/enrol/authorize/index.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,8 +18,7 @@
  * Adds new instance of enrol_authorize to specified course
  * or edits current instance.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/lang/en/enrol_authorize.php b/enrol/authorize/lang/en/enrol_authorize.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
@@ -16,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'enrol_authorize', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'enrol_authorize', language 'en'.
  *
  * @package   enrol_authorize
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/enrol/authorize/localfuncs.php b/enrol/authorize/localfuncs.php
@@ -19,8 +19,7 @@
  *
  * This plugin allows you to set up paid courses, using authorize.net.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/locallib.php b/enrol/authorize/locallib.php
@@ -19,8 +19,7 @@
  *
  * This plugin allows you to set up paid courses, using authorize.net.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/uploadcsv.php b/enrol/authorize/uploadcsv.php
@@ -17,8 +17,7 @@
 /**
  * Authorize.Net enrolment plugin - support for user self unenrolment.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/authorize/version.php b/enrol/authorize/version.php
@@ -17,8 +17,7 @@
 /**
  * Authorize.Net enrolment plugin version specification.
  *
- * @package    enrol
- * @subpackage authorize
+ * @package    enrol_authorize
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/bulkchange.php b/enrol/bulkchange.php
@@ -17,8 +17,7 @@
 /**
  * Bulk user enrolment processing.
  *
- * @package    core
- * @subpackage enrol
+ * @package    core_enrol
  * @copyright  2011 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/bulkchange_forms.php b/enrol/bulkchange_forms.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
@@ -18,8 +17,7 @@
 /**
  * This file contains form for bulk changing user enrolments.
  *
- * @package    core
- * @subpackage enrol
+ * @package    core_enrol
  * @copyright  2011 Sam Hemelryk
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/cohort/lang/en/enrol_cohort.php b/enrol/cohort/lang/en/enrol_cohort.php
@@ -15,7 +15,7 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'enrol_cohort', language 'en'
+ * Strings for component 'enrol_cohort', language 'en'.
  *
  * @package    enrol_cohort
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}

diff --git a/enrol/guest/addinstance.php b/enrol/guest/addinstance.php
@@ -17,8 +17,7 @@
 /**
  * Adds new instance of enrol_guest to specified course.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/db/upgrade.php b/enrol/guest/db/upgrade.php
@@ -15,10 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * This file keeps track of upgrades to the guest enrolment plugin
+ * This file keeps track of upgrades to the guest enrolment plugin.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2011 Petr Skoda {@link http://skodak.org
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/lang/en/enrol_guest.php b/enrol/guest/lang/en/enrol_guest.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
@@ -16,10 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'enrol_guest', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'enrol_guest', language 'en'.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 onwards Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/lib.php b/enrol/guest/lib.php
@@ -20,8 +20,7 @@
  * This plugin does not add any entries into the user_enrolments table,
  * the access control is granted on the fly via the tricks in require_login().
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/locallib.php b/enrol/guest/locallib.php
@@ -17,8 +17,7 @@
 /**
  * Guest access plugin implementation.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/settings.php b/enrol/guest/settings.php
@@ -17,8 +17,7 @@
 /**
  * Guest access plugin settings and presets.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/guest/version.php b/enrol/guest/version.php
@@ -17,8 +17,7 @@
 /**
  * Guest access plugin version specification.
  *
- * @package    enrol
- * @subpackage guest
+ * @package    enrol_guest
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/db/install.php b/enrol/imsenterprise/db/install.php
@@ -17,8 +17,7 @@
 /**
  * imsenterprise enrolment plugin installation.
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2011 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/db/upgrade.php b/enrol/imsenterprise/db/upgrade.php
@@ -17,8 +17,7 @@
 /**
  * This file keeps track of upgrades to the imsenterprise enrolment plugin
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2011 Petr Skoda {@link http://skodak.org
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/lang/en/enrol_imsenterprise.php b/enrol/imsenterprise/lang/en/enrol_imsenterprise.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
@@ -16,10 +15,9 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * Strings for component 'enrol_imsenterprise', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'enrol_imsenterprise', language 'en'.
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/lib.php b/enrol/imsenterprise/lib.php
@@ -20,8 +20,7 @@
  * This plugin lets the user specify an IMS Enterprise file to be processed.
  * The IMS Enterprise file is mainly parsed on a regular cron,
  * but can also be imported via the UI (Admin Settings).
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2010 Eugene Venter
  * @author     Eugene Venter - based on code by Dan Stowell
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/enrol/imsenterprise/locallib.php b/enrol/imsenterprise/locallib.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
@@ -18,8 +17,7 @@
 /**
  * IMS Enterprise enrol plugin implementation.
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2010 Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/settings.php b/enrol/imsenterprise/settings.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
@@ -18,8 +17,7 @@
 /**
  * IMS Enterprise enrolments plugin settings and presets.
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2010 Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/imsenterprise/version.php b/enrol/imsenterprise/version.php
@@ -17,8 +17,7 @@
 /**
  * IMS Enterprise file enrolment plugin version specification.
  *
- * @package    enrol
- * @subpackage imsenterprise
+ * @package    enrol_imsenterprise
  * @copyright  2010 Eugene Venter
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/enrol/index.php b/enrol/index.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
@@ -18,8 +17,7 @@
 /**
  * This page shows all course enrolment options for current user.
  *
- * @package    core
- * @subpackage enrol
+ * @package    core_enrol
  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */