Huge PHPDoc update.

PMAStandard/Sniffs/Commenting/FileCommentSniff.php

@@ -493,7 +493,7 @@ protected function processTags($commentStart, $commentEnd)
      * @param PHP_CodeSniffer_CommentParser_DocElement $tagElement The doc comment
      *                                                             element.
      *
-     * @return void
+     * @return string|int
      */
     protected function getIndentation($tagName, $tagElement)
     {

gis_data_editor.php

@@ -12,7 +12,7 @@
  *
  * @param string $variable variable to be escaped
  *
- * @return escaped variable
+ * @return string escaped variable
  */
 function escape($variable)
 {

libraries/Advisor.class.php

@@ -264,7 +264,7 @@ function addRule($type, $rule)
      *
      * @param array $matches List of matched elements form preg_replace_callback
      *
-     * @return String Replacement value
+     * @return string Replacement value
      */
     private function _replaceLinkURL($matches)
     {
@@ -276,7 +276,7 @@ private function _replaceLinkURL($matches)
      *
      * @param array $matches List of matched elements form preg_replace_callback
      *
-     * @return String Replacement value
+     * @return string Replacement value
      */
     private function _ruleExprEvaluateFired($matches)
     {
@@ -300,7 +300,7 @@ private function _ruleExprEvaluateFired($matches)
      *
      * @param array $matches List of matched elements form preg_replace_callback
      *
-     * @return String Replacement value
+     * @return string Replacement value
      */
     private function _ruleExprEvaluateVariable($matches)
     {
@@ -324,6 +324,8 @@ private function _ruleExprEvaluateVariable($matches)
      *                            whole expr
      *
      * @return string result of evaluated expression
+     *
+     * @throws Exception
      */
     function ruleExprEvaluate($expr, $ignoreUntil = 0)
     {

libraries/DatabaseInterface.class.php

@@ -41,7 +41,7 @@ class PMA_DatabaseInterface
     /**
      * Constructor
      *
-     * @param object $ext PMA_DBI_Extension object to be used for database queries
+     * @param PMA_DBI_Extension $ext Object to be used for database queries
      */
     public function __construct(PMA_DBI_Extension $ext)
     {

libraries/DisplayResults.class.php

@@ -274,28 +274,28 @@ private  function _setDefaultTransformations()
     /**
      * Set properties which were not initialized at the constructor
      *
-     * @param type $unlim_num_rows integer the total number of rows returned by
+     * @param integer $unlim_num_rows the total number of rows returned by
      *                                     the SQL query without any appended
      *                                     "LIMIT" clause programmatically
-     * @param type $fields_meta    array   meta information about fields
-     * @param type $is_count       boolean
-     * @param type $is_export      integer
-     * @param type $is_func        boolean
-     * @param type $is_analyse     integer
-     * @param type $num_rows       integer total no. of rows returned by SQL query
-     * @param type $fields_cnt     integer total no.of fields returned by SQL query
-     * @param type $querytime      double  time taken for execute the SQL query
-     * @param type $pmaThemeImage  string  path for theme images directory
-     * @param type $text_dir       string
-     * @param type $is_maint       boolean
-     * @param type $is_explain     boolean
-     * @param type $is_show        boolean
-     * @param type $showtable      array   table definitions
-     * @param type $printview      string
-     * @param type $url_query      string  URL query
-     * @param type $editable       boolean whether the resutls set is editable
+     * @param array   $fields_meta    meta information about fields
+     * @param boolean $is_count
+     * @param integer $is_export
+     * @param boolean $is_func
+     * @param integer $is_analyse
+     * @param integer $num_rows       total no. of rows returned by SQL query
+     * @param integer $fields_cnt     total no.of fields returned by SQL query
+     * @param double  $querytime      time taken for execute the SQL query
+     * @param string  $pmaThemeImage  path for theme images directory
+     * @param string  $text_dir
+     * @param boolean $is_maint
+     * @param boolean $is_explain
+     * @param boolean $is_show
+     * @param array   $showtable      table definitions
+     * @param string  $printview
+     * @param string  $url_query      URL query
+     * @param boolean $editable       whether the results set is editable
      *
-     * @return  void
+     * @return void
      *
      * @see     sql.php
      */
@@ -979,12 +979,12 @@ private function _getAdditionalFieldsForTableNavigation(
     /**
      * Get the headers of the results table
      *
-     * @param array   &$is_display                 which elements to display
-     * @param array   $analyzed_sql                the analyzed query
-     * @param string  $sort_expression             sort expression
-     * @param string  $sort_expression_nodirection sort expression without direction
-     * @param string  $sort_direction              sort direction
-     * @param boolean $is_limited_display          with limited operations or not
+     * @param array        &$is_display                 which elements to display
+     * @param array|string $analyzed_sql                the analyzed query
+     * @param string       $sort_expression             sort expression
+     * @param string       $sort_expression_nodirection sort expression without direction
+     * @param string       $sort_direction              sort direction
+     * @param boolean      $is_limited_display          with limited operations or not
      *
      * @return string html content
      *

libraries/PDF.class.php

@@ -38,7 +38,6 @@ class PMA_PDF extends TCPDF
      *                             temporary data on filesystem (slower).
      * @param boolean $pdfa        If TRUE set the document to PDF/A mode.
      *
-     * @return void
      * @access public
      */
     public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4',

libraries/Util.class.php

@@ -2914,7 +2914,7 @@ public static function cacheUnset($var, $server = 0)
      * function because in PHP, decbin() supports only 32 bits
      * on 32-bit servers
      *
-     * @param numeric $value  coming from a BIT field
+     * @param number  $value  coming from a BIT field
      * @param integer $length length
      *
      * @return string  the printable value
@@ -3917,7 +3917,7 @@ public static function getServerType()
      *
      * @param string $limit_clause limit clause
      *
-     * @return array Start and length attributes of the limit clause
+     * @return array|void Start and length attributes of the limit clause
      */
     public static function analyzeLimitClause($limit_clause)
     {

libraries/bookmark.lib.php

@@ -49,7 +49,7 @@ function PMA_Bookmark_getParams()
  *
  * @access public
  *
- * @global resource the controluser db connection handle
+ * @global resource $controllink the controluser db connection handle
  */
 function PMA_Bookmark_getList($db)
 {
@@ -105,7 +105,7 @@ function PMA_Bookmark_getList($db)
  *
  * @access  public
  *
- * @global  resource  the controluser db connection handle
+ * @global  resource $controllink the controluser db connection handle
  *
  */
 function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = false,
@@ -148,7 +148,7 @@ function PMA_Bookmark_get($db, $id, $id_field = 'id', $action_bookmark_all = fal
  *
  * @access  public
  *
- * @global  resource  the controluser db connection handle
+ * @global  resource $controllink the controluser db connection handle
  */
 function PMA_Bookmark_save($bkm_fields, $all_users = false)
 {
@@ -186,7 +186,7 @@ function PMA_Bookmark_save($bkm_fields, $all_users = false)
  *
  * @access  public
  *
- * @global  resource  the controluser db connection handle
+ * @global  resource $controllink the controluser db connection handle
  */
 function PMA_Bookmark_delete($db, $id)
 {

libraries/core.lib.php

@@ -201,7 +201,7 @@ function PMA_securePath($path)
  * @param string|array $message_args   arguments applied to $error_message
  * @param boolean      $delete_session whether to delete session cookie
  *
- * @return exit
+ * @return void
  */
 function PMA_fatalError(
     $error_message, $message_args = null, $delete_session = true

libraries/dbi/DBIDummy.class.php

@@ -693,7 +693,7 @@ public function moreResults($link = null)
      *
      * @param object $link the connection object
      *
-     * @return bool false
+     * @return boolean false
      */
     public function nextResult($link = null)
     {

libraries/dbi/DBIExtension.int.php

@@ -49,7 +49,7 @@ public function selectDb($dbname, $link = null);
      * @param object $link    connection object
      * @param int    $options query options
      *
-     * @return result object|bool
+     * @return object|bool result
      */
     public function realQuery($query, $link, $options);
 
@@ -121,7 +121,7 @@ public function moreResults($link = null);
     /**
      * Prepare next result from multi_query
      *
-     * @param objecy $link the connection object
+     * @param object $link the connection object
      *
      * @return bool true or false
      */

libraries/dbi/DBIMysql.class.php

@@ -315,7 +315,7 @@ public function moreResults($link = null)
      *
      * @param object $link the connection object
      *
-     * @return bool false
+     * @return boolean false
      */
     public function nextResult($link = null)
     {

libraries/dbi/drizzle-wrappers.lib.php

@@ -133,8 +133,6 @@ class PMA_DrizzleCon
      * Constructor
      *
      * @param DrizzleCon $dcon connection handle
-     *
-     * @return void
      */
     public function __construct(DrizzleCon $dcon)
     {

libraries/display_export.lib.php

@@ -17,7 +17,7 @@
  *
  * @param string $str option name
  *
- * @return void
+ * @return string|void
  */
 function PMA_exportCheckboxCheck($str)
 {

libraries/display_select_lang.lib.php

@@ -16,7 +16,7 @@
  * @param array $a The first language being compared
  * @param array $b The second language being compared
  *
- * @return the sorted array
+ * @return int the sorted array
  */
 function PMA_languageCmp($a, $b)
 {

libraries/engines/pbxt.lib.php

@@ -106,6 +106,11 @@ function resolveTypeSize($formatted_size)
     }
 
     //--------------------
+    /**
+     * Get information about pages
+     *
+     * @return array Information about pages
+     */
     function getInfoPages()
     {
         $pages = array();
@@ -114,6 +119,13 @@ function getInfoPages()
     }
 
     //--------------------
+    /**
+     * Get content of a page
+     *
+     * @param string $id Id of searched page
+     *
+     * @return string
+     */
     function getPage($id)
     {
         if (! array_key_exists($id, $this->getInfoPages())) {
@@ -125,6 +137,11 @@ function getPage($id)
         return $this->$id();
     }
 
+    /**
+     * Get content of documentation page
+     *
+     * @return string
+     */
     function getPageDocumentation()
     {
         $output = '<p>' . sprintf(

libraries/file_listing.lib.php

@@ -68,7 +68,7 @@ function PMA_getFileSelectOptions($dir, $extensions = '', $active = '')
 /**
  * Get currently supported decompressions.
  *
- * @return string | separated list of extensions usable in PMA_getDirContent
+ * @return string separated list of extensions usable in PMA_getDirContent
  */
 function PMA_supportedDecompressions()
 {

libraries/gis/pma_gis_geometrycollection.php

@@ -32,7 +32,7 @@ private function __construct()
     /**
      * Returns the singleton.
      *
-     * @return the singleton
+     * @return PMA_GIS_Geometrycollection the singleton
      * @access public
      */
     public static function singleton()

libraries/gis/pma_gis_multilinestring.php

@@ -328,8 +328,8 @@ public function getShape($row_data)
     /**
      * Generate parameters for the GIS data editor from the value of the GIS column.
      *
-     * @param string $value of the GIS column
-     * @param index  $index of the geometry
+     * @param string $value Value of the GIS column
+     * @param int    $index Index of the geometry
      *
      * @return array params for the GIS data editor from the value of the GIS column
      * @access public

libraries/gis/pma_gis_multipoint.php

@@ -281,8 +281,8 @@ public function getShape($row_data)
     /**
      * Generate parameters for the GIS data editor from the value of the GIS column.
      *
-     * @param string $value of the GIS column
-     * @param index  $index of the geometry
+     * @param string  $value Value of the GIS column
+     * @param integer $index Index of the geometry
      *
      * @return array params for the GIS data editor from the value of the GIS column
      * @access public

libraries/gis/pma_gis_multipolygon.php

@@ -464,8 +464,8 @@ public function getShape($row_data)
     /**
      * Generate parameters for the GIS data editor from the value of the GIS column.
      *
-     * @param string $value of the GIS column
-     * @param index  $index of the geometry
+     * @param string $value Value of the GIS column
+     * @param int    $index Index of the geometry
      *
      * @return array params for the GIS data editor from the value of the GIS column
      * @access public

libraries/gis/pma_gis_point.php

@@ -263,7 +263,7 @@ public function getShape($row_data)
      * Generate parameters for the GIS data editor from the value of the GIS column.
      *
      * @param string $value of the GIS column
-     * @param index  $index of the geometry
+     * @param int    $index of the geometry
      *
      * @return array params for the GIS data editor from the value of the GIS column
      * @access public

libraries/gis/pma_gis_polygon.php

@@ -445,7 +445,7 @@ public static function isPointInsidePolygon($point, $polygon)
      *
      * @param array $ring array of points forming the ring
      *
-     * @return array a point on the surface of the ring
+     * @return array|void a point on the surface of the ring
      * @access public
      * @static
      */
@@ -507,8 +507,8 @@ public static function getPointOnSurface($ring)
 
     /** Generate parameters for the GIS data editor from the value of the GIS column.
      *
-     * @param string $value of the GIS column
-     * @param index  $index of the geometry
+     * @param string $value Value of the GIS column
+     * @param int    $index Index of the geometry
      *
      * @return array params for the GIS data editor from the value of the GIS column
      * @access public