From 7a117e2378a1cbafac7c75126baaea464eddcf3f Mon Sep 17 00:00:00 2001
From: Madhura Jayaratne <madhura.cj@gmail.com>
Date: Sat, 12 May 2012 22:57:32 +0530
Subject: [PATCH] Fix some doc comments

---
 libraries/Error_Handler.class.php    |  4 ++--
 libraries/database_interface.lib.php | 22 ++++++++++++----------
 libraries/db_common.inc.php          |  1 +
 3 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/libraries/Error_Handler.class.php b/libraries/Error_Handler.class.php
index 3dde178a8d..c382731c9f 100644
--- a/libraries/Error_Handler.class.php
+++ b/libraries/Error_Handler.class.php
@@ -152,8 +152,8 @@ class PMA_Error_Handler
      *
      * @param string  $errorInfo   error message
      * @param integer $errorNumber error number
-     * @param string  $file
-     * @param integer $line
+     * @param string  $file        the file
+     * @param integer $line        the line number
      *
      * @return void
      */
diff --git a/libraries/database_interface.lib.php b/libraries/database_interface.lib.php
index e4160c1d58..f1e99cf3ac 100644
--- a/libraries/database_interface.lib.php
+++ b/libraries/database_interface.lib.php
@@ -1142,9 +1142,9 @@ function PMA_DBI_get_columns($database, $table, $column = null, $full = false, $
 /**
  * Returns all column names in given table
  *
- * @param string  $database name of database
- * @param string  $table    name of table to retrieve columns from
- * @param mixed   $link     mysql link resource
+ * @param string $database name of database
+ * @param string $table    name of table to retrieve columns from
+ * @param mixed  $link     mysql link resource
  *
  * @return null|array
  */
@@ -1263,6 +1263,8 @@ function PMA_DBI_get_variable($var, $type = PMA_DBI_GETVAR_SESSION, $link = null
  *
  * @param mixed   $link           mysql link resource|object
  * @param boolean $is_controluser whether link is for control user
+ *
+ * @return void
  */
 function PMA_DBI_postConnect($link, $is_controluser = false)
 {
@@ -1511,13 +1513,13 @@ function PMA_DBI_fetch_single_row($result, $type = 'ASSOC', $link = null)
  * // $users['admin']['John Doe'] = '123'
  * </code>
  *
- * @param string|mysql_result $result query or mysql result
- * @param string|integer      $key    field-name or offset
- *                                    used as key for array
- * @param string|integer      $value  value-name or offset
- *                                    used as value for array
- * @param resource            $link   mysql link
- * @param mixed               $options
+ * @param string|mysql_result $result  query or mysql result
+ * @param string|integer      $key     field-name or offset
+ *                                     used as key for array
+ * @param string|integer      $value   value-name or offset
+ *                                     used as value for array
+ * @param resource            $link    mysql link
+ * @param mixed               $options query options
  *
  * @return array resultrows or values indexed by $key
  */
diff --git a/libraries/db_common.inc.php b/libraries/db_common.inc.php
index 63fc4de1d4..296685cdb4 100644
--- a/libraries/db_common.inc.php
+++ b/libraries/db_common.inc.php
@@ -1,6 +1,7 @@
 <?php
 /* vim: set expandtab sw=4 ts=4 sts=4: */
 /**
+ * Common includes for the database level views
  *
  * @package PhpMyAdmin
  */