diff options
author | Michal Čihař <michal@cihar.com> | 2012-04-27 15:41:44 +0400 |
---|---|---|
committer | Michal Čihař <michal@cihar.com> | 2012-04-27 15:41:44 +0400 |
commit | c3afb50573a4f07b00eda920ef8d4327ee6eb3b6 (patch) | |
tree | 4c586bb64c46eaef87186aa3332966bca3431f57 | |
parent | 0e26eeb56a6844fbecea75c238dcc745cfb3beb5 (diff) |
Add docs to some files and methods
-rw-r--r-- | chk_rel.php | 1 | ||||
-rw-r--r-- | index.php | 3 | ||||
-rw-r--r-- | libraries/Advisor.class.php | 4 | ||||
-rw-r--r-- | libraries/Config.class.php | 2 | ||||
-rw-r--r-- | libraries/File.class.php | 9 |
5 files changed, 15 insertions, 4 deletions
diff --git a/chk_rel.php b/chk_rel.php index ea89eef2ca..3e8a0269bb 100644 --- a/chk_rel.php +++ b/chk_rel.php @@ -1,6 +1,7 @@ <?php /* vim: set expandtab sw=4 ts=4 sts=4: */ /** + * Displays status of phpMyAdmin configuration storage * * @package PhpMyAdmin */ @@ -1,9 +1,8 @@ <?php /* vim: set expandtab sw=4 ts=4 sts=4: */ /** - * forms frameset + * Creates frameset * - * or common.inc.php * @package PhpMyAdmin */ diff --git a/libraries/Advisor.class.php b/libraries/Advisor.class.php index dc6684aedd..9f17794ad9 100644 --- a/libraries/Advisor.class.php +++ b/libraries/Advisor.class.php @@ -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 */ diff --git a/libraries/Config.class.php b/libraries/Config.class.php index b14fb79174..df08dece3e 100644 --- a/libraries/Config.class.php +++ b/libraries/Config.class.php @@ -1435,6 +1435,8 @@ class PMA_Config } /** + * Saves config file. + * * @todo finish * * @return void diff --git a/libraries/File.class.php b/libraries/File.class.php index 515b93eec5..09f5e3a15f 100644 --- a/libraries/File.class.php +++ b/libraries/File.class.php @@ -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 * |