phpdoc

horde · Feb 3, 2014 · 463f713 · 463f713
1 parent f3fef9a
commit 463f713
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 45 deletions.
diff --git a/framework/Alarm/lib/Horde/Alarm.php b/framework/Alarm/lib/Horde/Alarm.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2007-2014 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
+ * @package   Alarm
  */
 
 /**
- * The Horde_Alarm:: class provides an interface to deal with reminders,
- * alarms and notifications through a standardized API.
+ * The Horde_Alarm class provides an interface to deal with reminders, alarms
+ * and notifications through a standardized API.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2007-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 abstract class Horde_Alarm
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Exception.php b/framework/Alarm/lib/Horde/Alarm/Exception.php
@@ -1,15 +1,24 @@
 <?php
 /**
- * Exception handler for the Horde_Alarm library.
- *
  * Copyright 2010-2014 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   Michael Slusarz <slusarz@horde.org>
- * @category Horde
- * @package  Alarm
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
+ */
+
+/**
+ * Exception handler for the Horde_Alarm library.
+ *
+ * @author    Michael Slusarz <slusarz@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Exception extends Horde_Exception_Wrapped
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Handler.php b/framework/Alarm/lib/Horde/Alarm/Handler.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Handler class is an interface for all Horde_Alarm handlers
  * that notifies of active alarms.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 abstract class Horde_Alarm_Handler
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Handler/Desktop.php b/framework/Alarm/lib/Horde/Alarm/Handler/Desktop.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Handler_Desktop class is a Horde_Alarm handler that notifies
  * of active alarms by desktop notification through webkit browsers.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Handler_Desktop extends Horde_Alarm_Handler
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Handler/Mail.php b/framework/Alarm/lib/Horde/Alarm/Handler/Mail.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Handler_Mail class is a Horde_Alarm handler that notifies
  * of active alarms by e-mail.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Handler_Mail extends Horde_Alarm_Handler
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Handler/Notify.php b/framework/Alarm/lib/Horde/Alarm/Handler/Notify.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Handler_Notification class is a Horde_Alarm handler that
  * notifies of active alarms over the Horde_Notification system.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Handler_Notify extends Horde_Alarm_Handler
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Null.php b/framework/Alarm/lib/Horde/Alarm/Null.php
@@ -5,14 +5,20 @@
  * See the enclosed file COPYING for license information (LGPL). If you
  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
  *
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 
 /**
  * Null Alarm driver.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Null extends Horde_Alarm
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Object.php b/framework/Alarm/lib/Horde/Alarm/Object.php
@@ -1,19 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Object class is a Horde_Alarm storage implementation using
  * an object instance.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Object extends Horde_Alarm
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Sql.php b/framework/Alarm/lib/Horde/Alarm/Sql.php
@@ -1,22 +1,27 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2007-2014 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
+ * @package   Alarm
  */
 
 /**
  * The Horde_Alarm_Sql class is a Horde_Alarm storage implementation using the
  * Horde Db package.
  *
- * The table structure can be created by the
- * migration script.
+ * The table structure can be created by the migration script.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2007-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Sql extends Horde_Alarm
 {

diff --git a/framework/Alarm/lib/Horde/Alarm/Translation.php b/framework/Alarm/lib/Horde/Alarm/Translation.php
@@ -1,18 +1,25 @@
 <?php
 /**
- * @package Alarm
- *
  * Copyright 2010-2014 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
+ * @package   Alarm
  */
 
 /**
- * Horde_Alarm_Translation is the translation wrapper class for Horde_Alarm.
+ * Horde_Alarm_Translation class is the translation wrapper class for
+ * Horde_Alarm.
  *
- * @author  Jan Schneider <jan@horde.org>
- * @package Alarm
+ * @author    Jan Schneider <jan@horde.org>
+ * @category  Horde
+ * @copyright 2010-2014 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Alarm
  */
 class Horde_Alarm_Translation extends Horde_Translation
 {