Add docs to some files and methods

This commit is contained in:
Michal Čihař 2012-04-27 13:41:44 +02:00
parent 0e26eeb56a
commit c3afb50573
5 changed files with 15 additions and 4 deletions

View File

@ -1,6 +1,7 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Displays status of phpMyAdmin configuration storage
*
* @package PhpMyAdmin
*/

View File

@ -1,9 +1,8 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* forms frameset
* Creates frameset
*
* or common.inc.php
* @package PhpMyAdmin
*/

View File

@ -1,8 +1,8 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* A simple rules engine, that parses and executes the rules in advisory_rules.txt. Adjusted to phpMyAdmin
*
* A simple rules engine, that parses and executes the rules in advisory_rules.txt.
* Adjusted to phpMyAdmin.
*
* @package PhpMyAdmin
*/

View File

@ -1435,6 +1435,8 @@ class PMA_Config
}
/**
* Saves config file.
*
* @todo finish
*
* @return void

View File

@ -10,9 +10,11 @@ if (! defined('PHPMYADMIN')) {
}
/**
* File wrapper class
*
* @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
@ -155,6 +157,7 @@ class PMA_File
}
/**
* Gets file content
*
* @return string binary file content
*
@ -192,7 +195,10 @@ class PMA_File
}
/**
* Whether file is uploaded.
*
* @access public
*
* @return bool
*/
function isUploaded()
@ -212,6 +218,7 @@ class PMA_File
}
/**
* Initializes object from uploaded file.
*
* @param string $name name of file uploaded
*
@ -232,6 +239,8 @@ class PMA_File
}
/**
*
*
* @param string $key the md5 hash of the column name
* @param string $rownumber
*