Next round of automatic phpdoc fixes.

horde · Mar 9, 2017 · e7d646e · e7d646e
1 parent 091c4a2
commit e7d646e
Show file tree

Hide file tree

Showing 26 changed files with 159 additions and 123 deletions.
diff --git a/framework/Auth/lib/Horde/Auth.php b/framework/Auth/lib/Horde/Auth.php
@@ -16,11 +16,12 @@
  * The Horde_Auth class provides some useful authentication-related utilities
  * and constants for the Auth package.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth
 {

diff --git a/framework/Auth/lib/Horde/Auth/Auto.php b/framework/Auth/lib/Horde/Auth/Auto.php
@@ -18,10 +18,11 @@
  * This is only for use in testing or behind a firewall; it should NOT be used
  * on a public, production machine.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Auto extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Base.php b/framework/Auth/lib/Horde/Auth/Base.php
@@ -16,11 +16,12 @@
  * The Horde_Auth_Base class provides a common abstracted interface to creating
  * various authentication backends.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 abstract class Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Composite.php b/framework/Auth/lib/Horde/Auth/Composite.php
@@ -15,10 +15,11 @@
  * The Horde_Auth_Composite class provides a way to combine two separate
  * drivers for admin vs. authentication purposes.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category Horde
- * @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @category  Horde
+ * @copyright 2002-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Composite extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Customsql.php b/framework/Auth/lib/Horde/Auth/Customsql.php
@@ -18,12 +18,14 @@
  * The Horde_Auth_Customsql class provides a sql implementation of the Horde
  * authentication system with the possibility to set custom-made queries.
  *
- * @author   Ronnie Garcia <ronnie@mk2.net>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Joel Vandal <joel@scopserv.com>
- * @category Horde
- * @license  http://opensource.org/licenses/lgpl-2.1.php LGPL-2.1
- * @package  Auth
+ * @author    Ronnie Garcia <ronnie@mk2.net>
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Joel Vandal <joel@scopserv.com>
+ * @category  Horde
+ * @copyright 2002 Ronnie Garcia <ronnie@mk2.net>
+ * @copyright 2002-2017 Horde LLC
+ * @license   http://opensource.org/licenses/lgpl-2.1.php LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Customsql extends Horde_Auth_Sql
 {

diff --git a/framework/Auth/lib/Horde/Auth/Cyrsql.php b/framework/Auth/lib/Horde/Auth/Cyrsql.php
@@ -90,11 +90,12 @@
  * );
  * </pre>
  *
- * @author   Ilya Krel <mail@krel.org>
- * @author   Jan Schneider <jan@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Ilya Krel <mail@krel.org>
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2002-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Cyrsql extends Horde_Auth_Sql
 {

diff --git a/framework/Auth/lib/Horde/Auth/Exception.php b/framework/Auth/lib/Horde/Auth/Exception.php
@@ -15,11 +15,12 @@
 /**
  * Exception class for the Horde_Auth package.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2010-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Exception extends Horde_Exception_Wrapped
 {

diff --git a/framework/Auth/lib/Horde/Auth/Ftp.php b/framework/Auth/lib/Horde/Auth/Ftp.php
@@ -16,11 +16,12 @@
  * The Horde_Auth_Ftp class provides an FTP implementation of the Horde
  * authentication system.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Max Kalika <max@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Max Kalika <max@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Ftp extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Http.php b/framework/Auth/lib/Horde/Auth/Http.php
@@ -15,10 +15,11 @@
  * The Horde_Auth_Http class transparently logs users in to Horde using
  * already present HTTP authentication headers.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Http extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Http/Remote.php b/framework/Auth/lib/Horde/Auth/Http/Remote.php
@@ -15,10 +15,11 @@
  * The Horde_Auth_Http_Remote class authenticates users against a remote
  * HTTP-Auth endpoint.
  *
- * @author   Duck <duck@obala.net>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Duck <duck@obala.net>
+ * @category  Horde
+ * @copyright 2007-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Http_Remote extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Imap.php b/framework/Auth/lib/Horde/Auth/Imap.php
@@ -17,12 +17,13 @@
  * The Horde_Auth_Imap:: class provides an IMAP implementation of the Horde
  * authentication system.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @author   Gaudenz Steinlin <gaudenz@soziologie.ch>
- * @author   Jan Schneider <jan@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @author    Gaudenz Steinlin <gaudenz@soziologie.ch>
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Imap extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Ipbasic.php b/framework/Auth/lib/Horde/Auth/Ipbasic.php
@@ -19,10 +19,11 @@
  * of IPs to be able to access a site, and that access is simply on/off - no
  * preferences, etc.
  *
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Ipbasic extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Kolab.php b/framework/Auth/lib/Horde/Auth/Kolab.php
@@ -15,14 +15,17 @@
 
 /**
  * The Horde_Auth_Kolab implementation of the Horde authentication system.
+ *
  * Derives from the Horde_Auth_Imap authentication object, and provides
  * parameters to it based on the global Kolab configuration.
  *
- * @author   Stuart Binge <s.binge@codefusion.co.za>
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Stuart Binge <s.binge@codefusion.co.za>
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2004-2007 Stuart Binge <s.binge@codefusion.co.za>
+ * @copyright 2008-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Kolab extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Ldap.php b/framework/Auth/lib/Horde/Auth/Ldap.php
@@ -18,10 +18,11 @@
  * 'preauthenticate' hook should return LDAP connection information in the
  * 'ldap' credentials key.
  *
- * @author   Jon Parise <jon@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Jon Parise <jon@horde.org>
+ * @category  Horde
+ * @copyright 1999-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Ldap extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Login.php b/framework/Auth/lib/Horde/Auth/Login.php
@@ -1,21 +1,29 @@
 <?php
 /**
- * The Horde_Auth_login:: class provides a system login implementation of
- * the Horde authentication system.
- *
- * This Auth driver is useful if you have a shadow password system
- * where the Horde_Auth_Passwd driver doesn't work.
- *
  * Copyright 2004-2017 Horde LLC (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you did
  * not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
  * @author   Jan Schneider <jan@horde.org>
  * @category Horde
- * @license http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
  * @package  Auth
  */
+
+/**
+ * The Horde_Auth_login:: class provides a system login implementation of
+ * the Horde authentication system.
+ *
+ * This Auth driver is useful if you have a shadow password system
+ * where the Horde_Auth_Passwd driver doesn't work.
+ *
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2004-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
+ */
 class Horde_Auth_Login extends Horde_Auth_Base
 {
     /**

diff --git a/framework/Auth/lib/Horde/Auth/Msad.php b/framework/Auth/lib/Horde/Auth/Msad.php
@@ -15,12 +15,12 @@
  * The Horde_Auth_Msad class provides an experimental MSAD extension of the
  * LDAP implementation of the Horde authentication system.
  *
- * @todo Use Horde_Ldap
- *
- * @author   Francois Helly <fhelly@bebop-design.net>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Francois Helly <fhelly@bebop-design.net>
+ * @category  Horde
+ * @copyright 2007-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
+ * @todo      Use Horde_Ldap
  */
 class Horde_Auth_Msad extends Horde_Auth_Ldap
 {

diff --git a/framework/Auth/lib/Horde/Auth/Pam.php b/framework/Auth/lib/Horde/Auth/Pam.php
@@ -23,10 +23,11 @@
  *
  *      http://pecl.php.net/package/PAM
  *
- * @author   Jon Parise <jon@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Jon Parise <jon@horde.org>
+ * @category  Horde
+ * @copyright 2004-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Pam extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Passwd.php b/framework/Auth/lib/Horde/Auth/Passwd.php
@@ -17,11 +17,13 @@
  * The Horde_Auth_Passwd class provides a passwd-file implementation of the
  * Horde authentication system.
  *
- * @author   Rasmus Lerdorf <rasmus@php.net>
- * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Rasmus Lerdorf <rasmus@php.net>
+ * @author    Chuck Hagenbuch <chuck@horde.org>
+ * @category  Horde
+ * @copyright 1997-2007 Rasmus Lerdorf <rasmus@php.net>
+ * @copyright 2002-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Passwd extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Peclsasl.php b/framework/Auth/lib/Horde/Auth/Peclsasl.php
@@ -22,10 +22,11 @@
  * This driver relies on the PECL sasl package:
  *   http://pecl.php.net/package/sasl
  *
- * @author   Jon Parise <jon@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Jon Parise <jon@horde.org>
+ * @category  Horde
+ * @copyright 2004-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Peclsasl extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Radius.php b/framework/Auth/lib/Horde/Auth/Radius.php
@@ -18,10 +18,11 @@
  * This class requires the 'radius' PECL extension:
  *   http://pecl.php.net/package/radius
  *
- * @author   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2002-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Radius extends Horde_Auth_Base
 {

diff --git a/framework/Auth/lib/Horde/Auth/Shibboleth.php b/framework/Auth/lib/Horde/Auth/Shibboleth.php
@@ -19,10 +19,11 @@
  * takes the username from the HTTP headers that should be set by the
  * Shibboleth SP.
  *
- * @author   Cassio Nishiguchi <cassio@protectnetwork.org>
- * @category Horde
- * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
- * @package  Auth
+ * @author    Cassio Nishiguchi <cassio@protectnetwork.org>
+ * @category  Horde
+ * @copyright 2006 9Star Research, Inc.
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
  */
 class Horde_Auth_Shibboleth extends Horde_Auth_Base
 {