From 355a8f6111f53bc59ab5c5f3773ffaa326198ff6 Mon Sep 17 00:00:00 2001
From: Dominique Fournier <dominique@fournier38.fr>
Date: Fri, 1 Aug 2014 12:33:27 +0000
Subject: [PATCH] Add comments to phpdoc

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@1651 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
---
 config.php | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/config.php b/config.php
index b8820d5..c1d07db 100644
--- a/config.php
+++ b/config.php
@@ -66,7 +66,8 @@ class config
   /** Define a value for the parameter in the config file. Add all the default
       values if they are not defined
       @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)
   {
     if (!array_key_exists ($param, $this->default))
@@ -101,6 +102,7 @@ class config
     if (@file_put_contents ($this->confFile, $txt, LOCK_EX) === FALSE)
       throw new Exception (sprintf ("Can't save configuration file '%s'",
                                     $this->confFile));
+    return TRUE;
   }
 
   /** Display the $values in PHP format to be "require" easily