Fix some phpdoc errors.

bs_change_mime_type.php

@@ -5,6 +5,10 @@
      * @version     1.0
      * @package     BLOBStreaming
      */
+
+    /**
+     * Core library.
+     */
     require_once './libraries/common.inc.php';
 
     /**

bs_play_media.php

@@ -5,6 +5,10 @@
      * @version     1.0
      * @package     BLOBStreaming
      */
+
+    /**
+     * Core library.
+     */
     require_once './libraries/common.inc.php';
 
     /*

libraries/File.class.php

@@ -4,6 +4,7 @@
  * file upload functions
  *
  * @version $Id$
+ * @package phpMyAdmin
  */
 
 /**
@@ -155,7 +156,6 @@ class PMA_File
      * @access  public
      * @uses    PMA_File::$_name
      * @param   string  $name   file name
-     * @access  public
      */
     function setName($name)
     {
@@ -1231,7 +1231,7 @@ class PMA_File
     /**
      * sets reference to most recent BLOB repository reference
      *
-     * @access  static public
+     * @access  public
      * @param   string - BLOB repository reference
     */
     static function setRecentBLOBReference($ref)
@@ -1242,7 +1242,7 @@ class PMA_File
     /**
      * retrieves reference to most recent BLOB repository reference
      *
-     * @access  static public
+     * @access  public
      * @return  string - most recent BLOB repository reference
     */
     static function getRecentBLOBReference()

libraries/Index.class.php

@@ -4,6 +4,7 @@
  * holds the datasbe index class
  *
  * @version $Id$
+ * @package phpMyAdmin
  */
 
 /**

libraries/common.inc.php

@@ -29,6 +29,7 @@
  * - authentication work
  *
  * @version $Id$
+ * @package phpMyAdmin
  */
 
 /**

libraries/config.default.php

@@ -1404,9 +1404,9 @@ $cfg['Export']['sql_drop_table'] = false;
 /**
  *
  *
- * @global boolean $cfg['Export']['sql_if_not_exists']
  * true by default for correct behavior when dealing with exporting
  * of VIEWs and the stand-in table
+ * @global boolean $cfg['Export']['sql_if_not_exists']
  */
 $cfg['Export']['sql_if_not_exists'] = true;
 
@@ -2361,7 +2361,7 @@ $cfg['DBG'] = array();
 /**
  * Output executed queries and their execution times
  *
- * @global boolean $cfg['DBG']['enable']
+ * @global boolean $cfg['DBG']['sql']
  */
 $cfg['DBG']['sql'] = false;
 
@@ -2369,7 +2369,7 @@ $cfg['DBG']['sql'] = false;
  * Make the DBG stuff available
  * To use the following, please install the DBG extension from http://dd.cron.ru/dbg/
  *
- * @global boolean $cfg['DBG']['enable']
+ * @global boolean $cfg['DBG']['php']
  */
 $cfg['DBG']['php'] = false;
 

libraries/dbi/mysqli.dbi.lib.php

@@ -10,7 +10,9 @@ if (! defined('PHPMYADMIN')) {
     exit;
 }
 
-// MySQL client API
+/**
+ * MySQL client API
+ */
 if (!defined('PMA_MYSQL_CLIENT_API')) {
     $client_api = explode('.', mysqli_get_client_info());
     define('PMA_MYSQL_CLIENT_API', (int)sprintf('%d%02d%02d', $client_api[0], $client_api[1], intval($client_api[2])));

libraries/export/codegen.php

@@ -10,7 +10,9 @@ if (! defined('PHPMYADMIN')) {
     exit;
 }
 
-// this gets executed twice so avoid a notice
+/**
+ * This gets executed twice so avoid a notice
+ */
 if (! defined('CG_FORMAT_NHIBERNATE_CS')) {
     define("CG_FORMAT_NHIBERNATE_CS", "NHibernate C# DO");
     define("CG_FORMAT_NHIBERNATE_XML", "NHibernate XML");

libraries/select_lang.lib.php

@@ -4,6 +4,7 @@
  * phpMyAdmin Language Loading File
  *
  * @version $Id$
+ * @package phpMyAdmin
  */
 if (! defined('PHPMYADMIN')) {
     exit;
@@ -124,7 +125,7 @@ function PMA_langSet(&$lang)
  *
  * @return  bool    true on success, otherwise false
  *
- * @global  $available_languages
+ * @global  array $available_languages
  *
  * @access  private
  */

navigation.php

@@ -4,6 +4,7 @@
  * the navigation frame - displays server, db and table selection tree
  *
  * @version $Id$
+ * @package phpMyAdmin
  * @uses $GLOBALS['pma']->databases
  * @uses $GLOBALS['server']
  * @uses $GLOBALS['db']
@@ -47,11 +48,11 @@
 require_once './libraries/common.inc.php';
 
 /**
- * finish and cleanup navigation.php script execution
+ * finish and cleanup navigation.php script execution, only to be used in navigation.php
  *
  * @uses $GLOBALS['controllink'] to close it
  * @uses $GLOBALS['userlink'] to close it
- * @access private only to be used in navigation.php
+ * @access private
  */
 function PMA_exitNavigationFrame()
 {
@@ -346,12 +347,12 @@ if ($GLOBALS['cfg']['LeftFrameLight'] && strlen($GLOBALS['db'])) {
  * @uses    PMA_generate_common_url()
  * @uses    PMA_getTableList()
  * @uses    PMA_displayTableList()
- * @global  $element_counter
+ * @global  integer $element_counter
- * @global  $img_minus
+ * @global  string $img_minus
- * @global  $img_plus
+ * @global  string $img_plus
- * @global  $href_left
+ * @global  string $href_left
- * @global  $db_start
+ * @global  string $db_start
- * @global  $common_url_query
+ * @global  string $common_url_query
  * @param   array   $ext_dblist extended db list
  * @param   integer $offset
  * @param   integer $count

pdf_schema.php

@@ -4,6 +4,7 @@
  * Contributed by Maxime Delorme and merged by lem9
  *
  * @version $Id$
+ * @package phpMyAdmin
  */
 
 /**

setup/config.php

@@ -8,6 +8,9 @@
  * @version    $Id$
  */
 
+/**
+ * Core libraries.
+ */
 require './lib/common.inc.php';
 require_once './setup/lib/Form.class.php';
 require_once './setup/lib/FormDisplay.class.php';

setup/frames/config.inc.php

@@ -12,6 +12,9 @@ if (!defined('PHPMYADMIN')) {
     exit;
 }
 
+/**
+ * Core libraries.
+ */
 require_once './setup/lib/FormDisplay.class.php';
 require_once './setup/lib/index.lib.php';
 

setup/frames/form.inc.php

@@ -12,6 +12,9 @@ if (!defined('PHPMYADMIN')) {
     exit;
 }
 
+/**
+ * Core libraries.
+ */
 require_once './setup/lib/Form.class.php';
 require_once './setup/lib/FormDisplay.class.php';
 require_once './setup/lib/form_processing.lib.php';

setup/frames/index.inc.php

@@ -12,6 +12,9 @@ if (!defined('PHPMYADMIN')) {
     exit;
 }
 
+/**
+ * Core libraries.
+ */
 require_once './libraries/display_select_lang.lib.php';
 require_once './setup/lib/FormDisplay.class.php';
 require_once './setup/lib/index.lib.php';

setup/frames/servers.inc.php

@@ -12,6 +12,9 @@ if (!defined('PHPMYADMIN')) {
     exit;
 }
 
+/**
+ * Core libraries.
+ */
 require_once './setup/lib/Form.class.php';
 require_once './setup/lib/FormDisplay.class.php';
 require_once './setup/lib/form_processing.lib.php';

setup/index.php

@@ -9,6 +9,9 @@
  * @version    $Id$
  */
 
+/**
+ * Core libraries.
+ */
 require './lib/common.inc.php';
 
 $page = filter_input(INPUT_GET, 'page');

setup/lib/FormDisplay.class.php

@@ -14,6 +14,9 @@
  * @version    $Id$
  */
 
+/**
+ * Core libraries.
+ */
 require_once './setup/lib/FormDisplay.tpl.php';
 require_once './setup/lib/validate.lib.php';
 require_once './libraries/js_escape.lib.php';

setup/lib/common.inc.php

@@ -11,6 +11,10 @@
 // TODO: remove
 error_reporting(E_ALL | E_STRICT);
 
+/**
+ * Do not include full common.
+ * @ignore
+ */
 define('PMA_MINIMUM_COMMON', TRUE);
 define('PMA_SETUP', TRUE);
 chdir('..');
@@ -204,7 +208,7 @@ function PMA_lang_desc($canonical_path)
 }
 
 /**
- * Wraps link in <a> tags and replaces argument separator in internal links
+ * Wraps link in &lt;a&gt; tags and replaces argument separator in internal links
  * to the one returned by PMA_get_arg_separator()
  *
  * @param string $link