Adding @package, second part.

This commit is contained in:
Michal Čihař
2008-11-24 11:05:40 +00:00
parent 688c9986de
commit 56941e509c
97 changed files with 283 additions and 142 deletions

View File

@@ -4,9 +4,12 @@
* phpMyAdmin fatal error display page
*
* @version $Id$
* @package phpMyAdmin
*/
/* Input sanitizing */
/**
* Input sanitizing.
*/
require_once './libraries/sanitizing.lib.php';
/* Get variables */

View File

@@ -3,6 +3,7 @@
/**
* @todo too much die here, or?
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -5,6 +5,7 @@
*
* @uses PMA_Bookmark_getList()
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -26,6 +26,7 @@
* @uses time()
* @uses PMA_getenv()
* @uses header() to send charset
* @package phpMyAdmin
*/
/**

View File

@@ -4,6 +4,7 @@
* Holds class PMA_Error
*
* @version $Id$
* @package phpMyAdmin
*/
/**
@@ -14,6 +15,7 @@ require_once './libraries/Message.class.php';
/**
* a single error
*
* @package phpMyAdmin
*/
class PMA_Error extends PMA_Message
{

View File

@@ -4,6 +4,7 @@
* Holds class PMA_Error_Handler
*
* @version $Id$
* @package phpMyAdmin
*/
/**
@@ -14,6 +15,7 @@ require_once './libraries/Error.class.php';
/**
* handling errors
*
* @package phpMyAdmin
*/
class PMA_Error_Handler
{

View File

@@ -12,8 +12,8 @@
* @todo replace error messages with localized string
* @todo when uploading a file into a blob field, should we also consider using
* chunks like in import? UPDATE `table` SET `field` = `field` + [chunk]
* @package phpMyAdmin
*/
class PMA_File
{
/**

View File

@@ -10,6 +10,7 @@
/**
* @since phpMyAdmin 3.0.0
*
* @package phpMyAdmin
*/
class PMA_Index
{
@@ -582,6 +583,9 @@ class PMA_Index
}
}
/**
* @package phpMyAdmin
*/
class PMA_Index_Column
{
/**

View File

@@ -4,12 +4,14 @@
* hold the PMA_List base class
*
* @version $Id$
* @package phpMyAdmin
*/
/**
* @todo add caching
* @since phpMyAdmin 2.9.10
* @abstract
* @package phpMyAdmin
*/
abstract class PMA_List extends ArrayObject
{

View File

@@ -4,6 +4,7 @@
* holds the PMA_List_Database class
*
* @version $Id$
* @package phpMyAdmin
*/
/**
@@ -23,6 +24,7 @@ require_once './libraries/List.class.php';
* @todo ? support --skip-showdatabases and user has only global rights
* @access public
* @since phpMyAdmin 2.9.10
* @package phpMyAdmin
*/
/*public*/ class PMA_List_Database extends PMA_List
{

View File

@@ -4,6 +4,7 @@
* Holds class PMA_Message
*
* @version $Id: Error.class.php 10738 2007-10-08 16:02:58Z cybot_tm $
* @package phpMyAdmin
*/
/**
@@ -47,6 +48,7 @@
* // strSomeLocaleMessage <sup>1</sup> strSomeMoreLocale<br />
* // strSomeEvenMoreLocale - some final words
* </code>
* @package phpMyAdmin
*/
class PMA_Message
{

View File

@@ -1,8 +1,13 @@
<?php
/**
* Enter description here...
* @package phpMyAdmin
*
*/
/**
* Database listing.
*/
require_once './libraries/List_Database.class.php';
/**
@@ -10,6 +15,7 @@ require_once './libraries/List_Database.class.php';
*
*
*
* @package phpMyAdmin
*/
class PMA
{

View File

@@ -4,11 +4,13 @@
* Library for extracting information about the partitions
*
* @version $Id$
* @package phpMyAdmin
*/
/**
* base Partition Class
* @package phpMyAdmin
*/
class PMA_Partition
{

View File

@@ -4,6 +4,7 @@
* Library for extracting information about the available storage engines
*
* @version $Id$
* @package phpMyAdmin
*/
/**
@@ -21,6 +22,7 @@ define('PMA_ENGINE_DETAILS_TYPE_BOOLEAN', 3); // 'ON' or 'OFF'
/**
* base Storage Engine Class
* @package phpMyAdmin
*/
class PMA_StorageEngine
{

View File

@@ -3,10 +3,12 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**
* @todo make use of PMA_Message and PMA_Error
* @package phpMyAdmin
*/
class PMA_Table
{

View File

@@ -2,6 +2,7 @@
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* @version $Id$
* @package phpMyAdmin-DBG
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,13 +4,16 @@
* Displays form for password change
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
// loic1: autocomplete feature of IE kills the "onchange" event handler and it
// must be replaced by the "onpropertychange" one in this case
/**
* loic1: autocomplete feature of IE kills the "onchange" event handler and it
* must be replaced by the "onpropertychange" one in this case
*/
$chg_evt_handler = (PMA_USR_BROWSER_AGENT == 'IE' && PMA_USR_BROWSER_VER >= 5)
? 'onpropertychange'
: 'onchange';

View File

@@ -4,6 +4,7 @@
* Displays form for creating database (if user has privileges for that)
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -23,6 +23,7 @@
* on MySQL 5.0.18.
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* Code for displaying language selection
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* library for displaying table with results from all sort of select queries
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -8,6 +8,7 @@
* - also changes made in js/functions.js
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -36,8 +36,10 @@ if (isset($plugin_list)) {
define('PMA_PDF_FONT', 'DejaVuSans');
require_once './libraries/tcpdf/tcpdf.php';
// Adapted from a LGPL script by Philip Clarke
/**
* Adapted from a LGPL script by Philip Clarke
* @package phpMyAdmin-Export-PDF
*/
class PMA_PDF extends TCPDF
{
var $tablewidths;

View File

@@ -4,6 +4,7 @@
* Set of functions used to build XML dumps of tables
*
* @version $Id$
* @package phpMyAdmin-Export-XML
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -5,6 +5,7 @@
*
* @todo rename to file_listing.lib.php
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -42,6 +42,7 @@
* @uses basename()
* @uses file_exists()
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -7,6 +7,7 @@
* $HTTP_AUTHORIZATION.
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id: header.inc.php 10719 2007-10-04 15:03:44Z cybot_tm $
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* Library that provides common import functions that are used by import plugins
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -10,6 +10,9 @@ if (! defined('PHPMYADMIN')) {
exit;
}
/**
* Load relations.
*/
require_once './libraries/relation.lib.php';
$cfgRelation = PMA_getRelationsParam();

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -5,6 +5,7 @@
* feature
*
* @version $Id$
* @package phpMyAdmin
*/

View File

@@ -10,6 +10,7 @@
* 2002/2/22 - by Yukihiro Kawada <kawada@den.fujifilm.co.jp>
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* displays the pma logo, links and db and server selection in left frame
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -10,6 +10,7 @@
* Make some wrappers for the top and bottoms of our files.
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -4,13 +4,14 @@
* Simple interface for creating OASIS OpenDocument files.
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/**
*
* Load ZIP handler.
*/
require_once './libraries/zip.lib.php';

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* Generic plugin interface.
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -4,6 +4,7 @@
* Set of functions used with the relation and pdf feature
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -4,6 +4,7 @@
* Set of functions used for cleaning up phpMyAdmin tables
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -1,9 +1,10 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* This is in a separate script because it's called from a number of scripts
*
* @version $Id$
* This is in a separate script because it's called from a number of scripts
* @package phpMyAdmin
*/
/**

View File

@@ -4,6 +4,7 @@
* Code for displaying server selection written by nijel
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -8,6 +8,7 @@
* @uses PMA_DBI_QUERY_STORE
* @uses $userlink
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -10,6 +10,7 @@
* @uses session_name()
* @uses session_start()
* @uses ini_set()
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -19,7 +19,8 @@
* It's easier to use only uppercase for proper sorting. In case of
* doubt, use the DEBUG code after this function's definition.
*
* @version$Id$
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -28,6 +28,7 @@
* href="syntax.css.php" />' at the moment.)
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -1,32 +1,33 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* PHP interface to MimerSQL Validator
*
* Copyright 2002, 2003 Robin Johnson <robbat2@users.sourceforge.net>
* http://www.orbis-terrarum.net/?l=people.robbat2
*
* All data is transported over HTTP-SOAP
* And uses the PEAR SOAP Module
*
* Install instructions for PEAR SOAP
* Make sure you have a really recent PHP with PEAR support
* run this: "pear install Mail_Mime Net_DIME SOAP"
*
* If you got this file from somewhere other than phpMyAdmin
* please be aware that the latest copy will always be in the
* phpMyAdmin subversion tree as
* $HeadURL: https://phpmyadmin.svn.sourceforge.net/svnroot/phpmyadmin/trunk/phpMyAdmin/libraries/sqlvalidator.class.php $
*
* This code that also used to depend on the PHP overload module, but that has been
* removed now.
*
* @access public
*
* @author Robin Johnson <robbat2@users.sourceforge.net>
*
* @version $Id$
*/
* PHP interface to MimerSQL Validator
*
* Copyright 2002, 2003 Robin Johnson <robbat2@users.sourceforge.net>
* http://www.orbis-terrarum.net/?l=people.robbat2
*
* All data is transported over HTTP-SOAP
* And uses the PEAR SOAP Module
*
* Install instructions for PEAR SOAP
* Make sure you have a really recent PHP with PEAR support
* run this: "pear install Mail_Mime Net_DIME SOAP"
*
* If you got this file from somewhere other than phpMyAdmin
* please be aware that the latest copy will always be in the
* phpMyAdmin subversion tree as
* $HeadURL: https://phpmyadmin.svn.sourceforge.net/svnroot/phpmyadmin/trunk/phpMyAdmin/libraries/sqlvalidator.class.php $
*
* This code that also used to depend on the PHP overload module, but that has been
* removed now.
*
* @access public
*
* @author Robin Johnson <robbat2@users.sourceforge.net>
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}

View File

@@ -28,6 +28,7 @@
* Also set a username and password if you have a private one
*
* @version $Id$
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -19,6 +19,7 @@
* @uses mb_internal_encoding()
* @uses defined()
* @todo a .lib filename should not have code in main(), split or rename file
* @package phpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;

View File

@@ -20,6 +20,7 @@
* Please provide a comment for your function, what it does and what parameters are available.
*
* @version $Id$
* @package phpMyAdmin-Transformation
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**
@@ -23,6 +24,7 @@
* Official ZIP file format: http://www.pkware.com/appnote.txt
*
* @access public
* @package phpMyAdmin
*/
class zipfile
{

View File

@@ -7,6 +7,7 @@
* that would read any file using a GET parameter, it would open a hole
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -48,6 +48,7 @@ require_once './libraries/tcpdf/tcpdf.php';
*
* @access public
* @see FPDF
* @package phpMyAdmin
*/
class PMA_PDF extends TCPDF {
/**
@@ -496,6 +497,7 @@ class PMA_PDF extends TCPDF {
*
* @access private
* @see PMA_RT
* @package phpMyAdmin
*/
class PMA_RT_Table {
/**
@@ -680,6 +682,7 @@ class PMA_RT_Table {
*
* @access private
* @see PMA_RT
* @package phpMyAdmin
*/
class PMA_RT_Relation {
/**
@@ -806,6 +809,7 @@ class PMA_RT_Relation {
*
* @access public
* @see PMA_PDF
* @package phpMyAdmin
*/
class PMA_RT {
/**

View File

@@ -1,8 +1,9 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
*
* phpinfo() wrapper to allow displaying only when configured to do so.
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -39,6 +39,7 @@
* @uses preg_replace()
* @uses htmlspecialchars()
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -7,6 +7,7 @@
* that would read any file using a GET parameter, it would open a hole
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -36,6 +36,7 @@
* @uses implode()
* @uses htmlspecialchars()
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -5,6 +5,7 @@
*
* @version $Id$
* @todo falcon storage enginge is not listed under dev.mysql.com/doc/refman but dev.mysql.com/doc/falcon/
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -5,6 +5,7 @@
* + reset status variables
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
/**
*
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -23,6 +23,7 @@ require_once './libraries/js_escape.lib.php';
/**
* Form management class, displays and processes forms
* @package phpMyAdmin-setup
*/
class FormDisplay
{

View File

@@ -4,14 +4,15 @@
* Simple wrapper just to enable error reporting and include config
*
* @version $Id$
* @package phpMyAdmin
*/
/**
*
*/
echo "Starting to parse config file...\n";
error_reporting(E_ALL);
/**
* Read config file.
*/
require './config.inc.php';
?>

View File

@@ -4,6 +4,7 @@
* @todo we must handle the case if sql.php is called directly with a query
* what returns 0 rows - to prevent cyclic redirects or includes
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -12,6 +12,9 @@
*/
require_once 'PHPUnit/Framework.php';
/**
* @package phpMyAdmin-test
*/
class Environment_test extends PHPUnit_Framework_TestCase
{
public function testPhpVersion()

View File

@@ -12,6 +12,9 @@
*/
require_once 'PHPUnit/Framework.php';
/**
* @package phpMyAdmin-test
*/
class FailTest extends PHPUnit_Framework_TestCase
{
public function testFail()

View File

@@ -32,6 +32,9 @@ $GLOBALS['charset'] = 'UTF-8';
require_once './libraries/string.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_STR_sub_test extends PHPUnit_Framework_TestCase
{
public function testMultiByte()

View File

@@ -20,6 +20,7 @@ require_once './libraries/blowfish.php';
/**
* Test java script escaping.
*
* @package phpMyAdmin-test
*/
class PMA_blowfish_test extends PHPUnit_Framework_TestCase
{

View File

@@ -21,6 +21,7 @@ require_once './libraries/js_escape.lib.php';
/**
* Test java script escaping.
*
* @package phpMyAdmin-test
*/
class PMA_escapeJsString_test extends PHPUnit_Framework_TestCase
{

View File

@@ -21,6 +21,7 @@ require_once './libraries/common.lib.php';
/**
* Test MySQL escaping.
*
* @package phpMyAdmin-test
*/
class PMA_escapeMySqlWildcards_test extends PHPUnit_Framework_TestCase
{

View File

@@ -14,6 +14,9 @@ require_once 'PHPUnit/Framework.php';
require_once './libraries/core.lib.php';
require_once './libraries/url_generating.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_generate_common_url_test extends PHPUnit_Framework_TestCase
{
public function setUp()

View File

@@ -13,6 +13,9 @@
require_once 'PHPUnit/Framework.php';
require_once './libraries/core.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_get_real_size_test extends PHPUnit_Framework_TestCase
{
public function testNull()

View File

@@ -13,6 +13,9 @@
require_once 'PHPUnit/Framework.php';
require_once './libraries/core.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_isValid_test extends PHPUnit_Framework_TestCase
{
public function testVarNotSetAfterTest()

View File

@@ -13,6 +13,9 @@
require_once 'PHPUnit/Framework.php';
require_once './libraries/common.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_pow_test extends PHPUnit_Framework_TestCase
{
public function testIntOverflow()

View File

@@ -13,6 +13,9 @@
require_once 'PHPUnit/Framework.php';
require_once './libraries/sanitizing.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_sanitize_test extends PHPUnit_Framework_TestCase
{
public function testXssInHref()

View File

@@ -13,6 +13,9 @@
require_once 'PHPUnit/Framework.php';
require_once './libraries/transformations.lib.php';
/**
* @package phpMyAdmin-test
*/
class PMA_transformation_getOptions_test extends PHPUnit_Framework_TestCase
{
public function testDefault()

View File

@@ -6,6 +6,7 @@
* @todo js error when view name is empty (strFormEmpty)
* @todo (also validate if js is disabled, after form submission?)
* @version $Id$
* @package phpMyAdmin
*/
/**

View File

@@ -3,6 +3,7 @@
* generate an WebApp file for Prism / WebRunner
*
* @see http://wiki.mozilla.org/Prism
* @package phpMyAdmin
*/
/**