DomCI : Update all the PHPDoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3279 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
2016-12-09 14:47:48 +00:00
parent b102168208
commit b55ea95fae
21 changed files with 953 additions and 424 deletions

View File

@@ -15,8 +15,10 @@ class ratelimitfile extends ratelimit
public $debug = false;
/** The function set a rate-limit
@return bool true if the rate-limit is not overloaded
false if the rate-limit is overloaded */
* @param string $name The rate-limit object to set
* @return bool true if the rate-limit is not overloaded
* false if the rate-limit is overloaded
*/
public function set ($name)
{
$this->storageOK();
@@ -62,7 +64,9 @@ class ratelimitfile extends ratelimit
}
/** The function delete a rate-limit
@return bool */
* @param string $name The rate-limit object to del
* @return bool
*/
public function del ($name)
{
$this->storageOK();
@@ -77,7 +81,8 @@ class ratelimitfile extends ratelimit
}
/** The function clean the storage with expired entries
@return bool */
* @return bool
*/
public function clean ()
{
$this->storageOK();
@@ -95,7 +100,8 @@ class ratelimitfile extends ratelimit
return TRUE;
}
/** Check the storageDir state */
/** Check the storageDir state
*/
private function storageOK ()
{
if (file_exists ($this->storageDir))