Add comments to phpdoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@1651 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2014-08-01 12:33:27 +00:00
parent 39bfbad1e9
commit 355a8f6111

View File

@@ -66,7 +66,8 @@ class config
/** Define a value for the parameter in the config file. Add all the default /** Define a value for the parameter in the config file. Add all the default
values if they are not defined values if they are not defined
@param string $param The option name @param string $param The option name
@param mixed $value The option value */ @param mixed $value The option value
@return TRUE if the parameter is saved or an exception */
public function set ($param, $value) public function set ($param, $value)
{ {
if (!array_key_exists ($param, $this->default)) if (!array_key_exists ($param, $this->default))
@@ -101,6 +102,7 @@ class config
if (@file_put_contents ($this->confFile, $txt, LOCK_EX) === FALSE) if (@file_put_contents ($this->confFile, $txt, LOCK_EX) === FALSE)
throw new Exception (sprintf ("Can't save configuration file '%s'", throw new Exception (sprintf ("Can't save configuration file '%s'",
$this->confFile)); $this->confFile));
return TRUE;
} }
/** Display the $values in PHP format to be "require" easily /** Display the $values in PHP format to be "require" easily