From 0071ad3bfd88780af24ebf9cb4d02eac76369994 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Tue, 5 Mar 2013 04:02:05 +0100 Subject: [ticket/10202] Improve method documentation. PHPBB3-10202 --- phpBB/includes/config/db_text.php | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'phpBB') diff --git a/phpBB/includes/config/db_text.php b/phpBB/includes/config/db_text.php index 7563a228f5..6449a2e02b 100644 --- a/phpBB/includes/config/db_text.php +++ b/phpBB/includes/config/db_text.php @@ -75,7 +75,7 @@ class phpbb_config_db_text } /** - * Removes a configuration option + * Removes the configuration option with the name $key. * * @param string $key The configuration option's name * @@ -87,7 +87,9 @@ class phpbb_config_db_text } /** - * Sets a configuration option's value + * Mass set configuration options: Receives an associative array, + * treats array keys as configuration option names and associated + * array values as their configuration option values. * * @param array $map Map from configuration names to values * @@ -118,7 +120,10 @@ class phpbb_config_db_text } /** - * Gets a set of configuration options as a key => value map. + * Mass get configuration options: Receives a set of configuration + * option names and returns the result as a key => value map where + * array keys are configuration option names and array values are + * associated config option values. * * @param array $keys Set of configuration option names * @@ -142,7 +147,7 @@ class phpbb_config_db_text } /** - * Removes multiple configuration options + * Mass delete configuration options. * * @param array $keys Set of configuration option names * -- cgit v1.2.1