MDL-39387 fix /auth phpdocs

BenKelada · Apr 27, 2013 · a2f1095 · a2f1095
1 parent cf5a329
commit a2f1095
Show file tree

Hide file tree

Showing 52 changed files with 299 additions and 185 deletions.
diff --git a/auth/cas/auth.php b/auth/cas/auth.php
@@ -1,17 +1,29 @@
 <?php
+// This file is part of Moodle - http://moodle.org/
+//
+// 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.
+//
+// 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.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @author Martin Dougiamas
- * @author Jerome GUTIERREZ
- * @author Iñaki Arenaza
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodle multiauth
- *
  * Authentication Plugin: CAS Authentication
  *
  * Authentication using CAS (Central Authentication Server).
  *
- * 2006-08-28  File created.
+ * @author Martin Dougiamas
+ * @author Jerome GUTIERREZ
+ * @author Iñaki Arenaza
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package auth_cas
  */
 
 if (!defined('MOODLE_INTERNAL')) {

diff --git a/auth/cas/cli/sync_users.php b/auth/cas/cli/sync_users.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
@@ -38,8 +37,7 @@
  * We have optimized it as best as we could for PostgreSQL and MySQL, with 27K students
  * we have seen this take 10 minutes.
  *
- * @package    auth
- * @subpackage CAS
+ * @package    auth_cas
  * @copyright  2007 Jerome Gutierrez - based on code by Martin Langhoff
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/cas/lang/en/auth_cas.php b/auth/cas/lang/en/auth_cas.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 'auth_cas', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_cas', language 'en'.
  *
  * @package   auth_cas
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/cas/version.php b/auth/cas/version.php
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    auth
- * @subpackage cas
+ * @package    auth_cas
  * @author     Martin Dougiamas
  * @author     Jerome GUTIERREZ
  * @author     Iñaki Arenaza

diff --git a/auth/email/auth.php b/auth/email/auth.php
@@ -1,15 +1,25 @@
 <?php
+// This file is part of Moodle - http://moodle.org/
+//
+// 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.
+//
+// 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.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @author Martin Dougiamas
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodle multiauth
- *
  * Authentication Plugin: Email Authentication
  *
- * Standard authentication function.
- *
- * 2006-08-28  File created.
+ * @author Martin Dougiamas
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
+ * @package auth_email
  */
 
 if (!defined('MOODLE_INTERNAL')) {

diff --git a/auth/email/lang/en/auth_email.php b/auth/email/lang/en/auth_email.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 'auth_email', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_email', language 'en'.
  *
  * @package   auth_email
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/email/version.php b/auth/email/version.php
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    auth
- * @subpackage email
+ * @package    auth_email
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/fc/auth.php b/auth/fc/auth.php
@@ -1,14 +1,26 @@
 <?php
+// This file is part of Moodle - http://moodle.org/
+//
+// 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.
+//
+// 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.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
- * @author Martin Dougiamas
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodle multiauth
- *
  * Authentication Plugin: FirstClass Authentication
- *
  * Authentication using a FirstClass server.
- *
- * 2006-08-28  File created.
+
+ * @package auth_fc
+ * @author Martin Dougiamas
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  */
 
 if (!defined('MOODLE_INTERNAL')) {

diff --git a/auth/fc/lang/en/auth_fc.php b/auth/fc/lang/en/auth_fc.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 'auth_fc', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_fc', language 'en'.
  *
  * @package   auth_fc
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/fc/version.php b/auth/fc/version.php
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    auth
- * @subpackage fc
+ * @package    auth_fc
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/imap/auth.php b/auth/imap/auth.php
@@ -1,15 +1,26 @@
 <?php
+// This file is part of Moodle - http://moodle.org/
+//
+// 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.
+//
+// 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.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @author Martin Dougiamas
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodle multiauth
- *
  * Authentication Plugin: IMAP Authentication
- *
  * Authenticates against an IMAP server.
  *
- * 2006-08-31  File created.
+ * @package auth_imap
+ * @author Martin Dougiamas
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  */
 
 if (!defined('MOODLE_INTERNAL')) {

diff --git a/auth/imap/lang/en/auth_imap.php b/auth/imap/lang/en/auth_imap.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 'auth_imap', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_imap', language 'en'.
  *
  * @package   auth_imap
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/imap/version.php b/auth/imap/version.php
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    auth
- * @subpackage imap
+ * @package    auth_imap
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/ldap/auth.php b/auth/ldap/auth.php
@@ -1,16 +1,27 @@
 <?php
+// This file is part of Moodle - http://moodle.org/
+//
+// 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.
+//
+// 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.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
- * @author Martin Dougiamas
- * @author Iñaki Arenaza
- * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
- * @package moodle multiauth
- *
  * Authentication Plugin: LDAP Authentication
- *
  * Authentication using LDAP (Lightweight Directory Access Protocol).
  *
- * 2006-08-28  File created.
+ * @package auth_ldap
+ * @author Martin Dougiamas
+ * @author Iñaki Arenaza
+ * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
  */
 
 if (!defined('MOODLE_INTERNAL')) {

diff --git a/auth/ldap/cli/sync_users.php b/auth/ldap/cli/sync_users.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
@@ -42,8 +41,7 @@
  * We have optimized it as best as we could for PostgreSQL and MySQL, with 27K students
  * we have seen this take 10 minutes.
  *
- * @package    auth
- * @subpackage ldap
+ * @package    auth_ldap
  * @copyright  2004 Martin Langhoff
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/ldap/lang/en/auth_ldap.php b/auth/ldap/lang/en/auth_ldap.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 'auth_ldap', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_ldap', language 'en'.
  *
  * @package   auth_ldap
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/ldap/version.php b/auth/ldap/version.php
@@ -17,8 +17,7 @@
 /**
  * Version details
  *
- * @package    auth
- * @subpackage ldap
+ * @package    auth_ldap
  * @author     Martin Dougiamas
  * @author     Iñaki Arenaza
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

diff --git a/auth/manual/auth.php b/auth/manual/auth.php
@@ -18,8 +18,7 @@
  * Authentication Plugin: Manual Authentication
  * Just does a simple check against the moodle database.
  *
- * @package    auth
- * @subpackage manual
+ * @package    auth_manual
  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/manual/db/upgrade.php b/auth/manual/db/upgrade.php
@@ -17,8 +17,7 @@
 /**
  * Manual authentication plugin upgrade code
  *
- * @package    auth
- * @subpackage manual
+ * @package    auth_manual
  * @copyright  2011 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/auth/manual/lang/en/auth_manual.php b/auth/manual/lang/en/auth_manual.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 'auth_manual', language 'en', branch 'MOODLE_20_STABLE'
+ * Strings for component 'auth_manual', language 'en'.
  *
  * @package   auth_manual
  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}

diff --git a/auth/manual/version.php b/auth/manual/version.php
@@ -17,8 +17,7 @@
 /**
  * Manual authentication plugin version information
  *
- * @package    auth
- * @subpackage manual
+ * @package    auth_manual
  * @copyright  2011 Petr Skoda (http://skodak.org)
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */