phpdoc refactoring.

horde · Apr 4, 2017 · 9d46228 · 9d46228
1 parent b1144c7
commit 9d46228
Show file tree

Hide file tree

Showing 71 changed files with 681 additions and 931 deletions.
diff --git a/framework/Pear/lib/Horde/Pear/Exception.php b/framework/Pear/lib/Horde/Pear/Exception.php
@@ -1,29 +1,24 @@
 <?php
 /**
- * This provides the standard exception class for this package.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * This provides the standard exception class for this package.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Exception extends Horde_Exception_Wrapped
 {

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents.php b/framework/Pear/lib/Horde/Pear/Package/Contents.php
@@ -1,29 +1,24 @@
 <?php
 /**
- * Defines a content generator for package.xml files.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Defines a content generator for package.xml files.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 interface Horde_Pear_Package_Contents
 {

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore.php
@@ -1,31 +1,25 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore:: defines "ignore" filters to be used when
- * generating package.xml filelists.
+ * Copyright 2010-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore:: defines "ignore" filters to be used when
  * generating package.xml filelists.
  *
- * Copyright 2010-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2010-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 interface Horde_Pear_Package_Contents_Ignore
 {

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Composer.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Composer.php
@@ -5,11 +5,10 @@
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category  Horde
- * @copyright 2015-2017 Horde LLC
- * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link      http://pear.horde.org/index.php?package=Pear
- * @package   Pear
+ * @author   Michael Slusarz <slusarz@horde.org>
+ * @category Horde
+ * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package  Pear
  */
 
 /**
@@ -19,7 +18,6 @@
  * @category  Horde
  * @copyright 2015-2017 Horde LLC
  * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link      http://pear.horde.org/index.php?package=Pear
  * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Composer

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Composite.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Composite.php
@@ -1,31 +1,25 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Composite:: combines several ignore
- * handlers.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore_Composite:: combines several ignore
  * handlers.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Composite
 implements Horde_Pear_Package_Contents_Ignore

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Dot.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Dot.php
@@ -1,29 +1,24 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Dot:: ignores "." and ".."
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
- * Horde_Pear_Package_Contents_Ignore_Dot:: ignores "." and ".."
- *
- * Copyright 2011-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.
+ * Horde_Pear_Package_Contents_Ignore_Dot:: ignores "." and "..".
  *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Dot
 implements Horde_Pear_Package_Contents_Ignore

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Git.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Git.php
@@ -1,31 +1,25 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Git:: indicates which files in a content
- * listing should be ignored based on the contents from a .gitignore file.
+ * Copyright 2010-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore_Git:: indicates which files in a content
  * listing should be ignored based on the contents from a .gitignore file.
  *
- * Copyright 2010-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2010-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Git
 implements Horde_Pear_Package_Contents_Ignore

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Hidden.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Hidden.php
@@ -1,29 +1,24 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Hidden:: ignores hidden files.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore_Hidden:: ignores hidden files.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Hidden
 implements Horde_Pear_Package_Contents_Ignore

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Nothing.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Nothing.php
@@ -1,29 +1,24 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Nothing:: ignores no file.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore_Nothing:: ignores no file.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Nothing
 implements Horde_Pear_Package_Contents_Ignore

diff --git a/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Patterns.php b/framework/Pear/lib/Horde/Pear/Package/Contents/Ignore/Patterns.php
@@ -1,31 +1,25 @@
 <?php
 /**
- * Horde_Pear_Package_Contents_Ignore_Patterns:: ignores files based on a
- * pattern list.
+ * Copyright 2011-2017 Horde LLC (http://www.horde.org/)
  *
- * PHP version 5
+ * See the enclosed file COPYING for license information (LGPL). If you
+ * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @category Horde
- * @package  Pear
  * @author   Gunnar Wrobel <wrobel@pardus.de>
+ * @category Horde
  * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @package  Pear
  */
 
 /**
  * Horde_Pear_Package_Contents_Ignore_Patterns:: ignores files based on a
  * pattern list.
  *
- * Copyright 2011-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.
- *
- * @category Horde
- * @package  Pear
- * @author   Gunnar Wrobel <wrobel@pardus.de>
- * @license  http://www.horde.org/licenses/lgpl21 LGPL 2.1
- * @link     http://pear.horde.org/index.php?package=Pear
+ * @author    Gunnar Wrobel <wrobel@pardus.de>
+ * @category  Horde
+ * @copyright 2011-2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL 2.1
+ * @package   Pear
  */
 class Horde_Pear_Package_Contents_Ignore_Patterns
 implements Horde_Pear_Package_Contents_Ignore