From cf7306545364bc5f0aea0421370609599bd24e37 Mon Sep 17 00:00:00 2001
From: Michael M Slusarz <slusarz@curecanti.org>
Date: Thu, 31 Dec 2009 12:38:12 -0700
Subject: [PATCH] Fix phpdoc errors

---
 imp/lib/Application.php    | 35 ++++++++++++++++++++---------------
 imp/lib/Compose.php        |  2 +-
 imp/lib/Imap/Tree.php      |  2 +-
 imp/lib/Prefs/Identity.php |  3 +--
 imp/lib/Ui/Compose.php     |  4 ++--
 imp/lib/Ui/Folder.php      |  8 ++++----
 6 files changed, 29 insertions(+), 25 deletions(-)

diff --git a/imp/lib/Application.php b/imp/lib/Application.php
index 05a5005df..2656a5188 100644
--- a/imp/lib/Application.php
+++ b/imp/lib/Application.php
@@ -1,4 +1,15 @@
 <?php
+/**
+ * IMP application API.
+ *
+ * This file defines Horde's core API interface. Other core Horde libraries
+ * can interact with Horde through this API.
+ *
+ * See the enclosed file COPYING for license information (GPL). If you
+ * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
+ *
+ * @package IMP
+ */
 
 /* Determine the base directories. */
 if (!defined('IMP_BASE')) {
@@ -19,17 +30,6 @@ if (!defined('HORDE_BASE')) {
  * Horde_Registry_Application::). */
 require_once HORDE_BASE . '/lib/core.php';
 
-/**
- * IMP application API.
- *
- * This file defines IMP's external API interface. Other applications
- * can interact with IMP through this API.
- *
- * See the enclosed file COPYING for license information (GPL). If you
- * did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
- *
- * @package IMP
- */
 class IMP_Application extends Horde_Registry_Application
 {
     /**
@@ -105,10 +105,15 @@ class IMP_Application extends Horde_Registry_Application
      * IMP base initialization.
      *
      * Global variables defined:
-     *   $imp_imap    - An IMP_Imap object
-     *   $imp_mbox    - Current mailbox information
-     *   $imp_notify  - A Horde_Notification_Listener object
-     *   $imp_search  - An IMP_Search object
+     *   $imp_imap     - An IMP_Imap object
+     *   $imp_mbox     - Current mailbox information
+     *   $imp_notify   - A Horde_Notification_Listener object
+     *   $imp_search   - An IMP_Search object
+     *   $notification - Notification object
+     *   $registry     - Registry object
+     *
+     * Global constants defined:
+     *   IMP_TEMPLATES - (string) Location of template files.
      *
      * @param array $args  Optional arguments:
      * <pre>
diff --git a/imp/lib/Compose.php b/imp/lib/Compose.php
index 5efe298fe..80806d84c 100644
--- a/imp/lib/Compose.php
+++ b/imp/lib/Compose.php
@@ -282,7 +282,7 @@ class IMP_Compose
      * @param string $data  The text of the draft message.
      *
      * @return string  Status string.
-     * @throw IMP_Compose_Exception
+     * @throws IMP_Compose_Exception
      */
     protected function _saveDraftServer($data)
     {
diff --git a/imp/lib/Imap/Tree.php b/imp/lib/Imap/Tree.php
index 5c8fd2f20..438e825ec 100644
--- a/imp/lib/Imap/Tree.php
+++ b/imp/lib/Imap/Tree.php
@@ -1644,7 +1644,7 @@ class IMP_Imap_Tree
     /**
      * Get any custom icon configured for the given element.
      *
-     * @params array $elt  A tree element.
+     * @param array $elt  A tree element.
      *
      * @return array  An array with the 'icon', 'icondir', and 'alt'
      *                information for the element, or false if no icon
diff --git a/imp/lib/Prefs/Identity.php b/imp/lib/Prefs/Identity.php
index 531548ba6..a9beeeaa9 100644
--- a/imp/lib/Prefs/Identity.php
+++ b/imp/lib/Prefs/Identity.php
@@ -11,8 +11,7 @@
  *
  * @author   Jan Schneider <jan@horde.org>
  * @author   Chuck Hagenbuch <chuck@horde.org>
- * @category IMP
- * @package  Horde_Prefs
+ * @package  IMP
  */
 class Imp_Prefs_Identity extends Horde_Prefs_Identity
 {
diff --git a/imp/lib/Ui/Compose.php b/imp/lib/Ui/Compose.php
index 83cd5a497..0b0043b87 100644
--- a/imp/lib/Ui/Compose.php
+++ b/imp/lib/Ui/Compose.php
@@ -17,8 +17,8 @@ class IMP_Ui_Compose
      * Expand addresses in a string. Only the last address in the string will
      * be expanded.
      *
-     * @var string $input             The input string.
-     * @var IMP_Compose $imp_compose  An IMP_Compose object.
+     * @param string $input             The input string.
+     * @param IMP_Compose $imp_compose  An IMP_Compose object.
      *
      * @return mixed  If a string, this value should be used as the new
      *                input string.  If an array, the first value is the
diff --git a/imp/lib/Ui/Folder.php b/imp/lib/Ui/Folder.php
index a52f97137..e563104f7 100644
--- a/imp/lib/Ui/Folder.php
+++ b/imp/lib/Ui/Folder.php
@@ -23,8 +23,8 @@ class IMP_Ui_Folder
     /**
      * Create the tree images for a list of folder elements.
      *
-     * @var array $rows     Folder rows returned from IMP_Imap_Tree::build().
-     * @var array $options  Additional options:
+     * @params array $rows     Folder rows returned from IMP_Imap_Tree::build().
+     * @params array $options  Additional options:
      * <pre>
      * 'expand_url' - (Horde_Url) The URL to use for expand/collapse links.
      * </pre>
@@ -47,8 +47,8 @@ class IMP_Ui_Folder
     /**
      * Create a tree image from a folder element entry.
      *
-     * @var array $elt      An entry returned from IMP_Imap_Tree::element().
-     * @var array $options  See self::getTreeImages().
+     * @params array $elt      An entry returned from IMP_Imap_Tree::element().
+     * @params array $options  See self::getTreeImages().
      *
      * @return string  The image string.
      */
-- 
2.11.0