add_param : useless output argument removed. 02/12702/9
Cedric Delamarre [Fri, 27 Sep 2013 10:34:53 +0000 (12:34 +0200)]
Change-Id: I10f2927d112d9ab73490f2237487d710dc5e5106

SEP/INDEX
SEP/SEP_132_add_param.odt [new file with mode: 0644]
scilab/CHANGES_5.5.X
scilab/modules/parameters/help/en_US/add_param.xml
scilab/modules/parameters/help/ja_JP/add_param.xml
scilab/modules/parameters/macros/add_param.sci

index f0512d7..c22ce76 100644 (file)
--- a/SEP/INDEX
+++ b/SEP/INDEX
@@ -127,3 +127,4 @@ SEP #128: nanreglin.
 SEP #129: HTLM parsing functions.
 SEP #130: Replace obsolete numdiff and derivative with new function numderivative.
 SEP #131: Modified matfile2sci to have an new input argument overwrite to overwrite the output file
+SEP #132: Remove useless output argument err of add_param function.
diff --git a/SEP/SEP_132_add_param.odt b/SEP/SEP_132_add_param.odt
new file mode 100644 (file)
index 0000000..b7d22a7
Binary files /dev/null and b/SEP/SEP_132_add_param.odt differ
index 5720c26..cd9b490 100644 (file)
@@ -6,6 +6,8 @@ Obsolete & Removed Functions
 
 * datatipContextMenu() and datatipEventhandler() removed (See bug #8646).
 
+* Second output argument of add_param removed (See SEP #132).
+
 
 Scilab Bug Fixes
 ================
index df03133..8786660 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[param_list,err] = add_param(list_name,param_name,param_value)</synopsis>
+        <synopsis>param_list = add_param(list_name,param_name,param_value)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
                     </para>
                 </listitem>
             </varlistentry>
-            <varlistentry>
-                <term>err</term>
-                <listitem>
-                    <para>an error flag which is set to %T if list_name is not of type plist (this list has not been initialized by a call to init_param).
-                    </para>
-                    <caution>
-                        This argument is obsolete and will be removed in Scilab 5.5.1.
-                    </caution>
-                </listitem>
-            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
@@ -102,6 +92,10 @@ mylist = add_param(mylist,'minbound',[0 0 0]);
                 <revnumber>5.5.0</revnumber>
                 <revremark>Second output argument (err) tagged as obsolete.</revremark>
             </revision>
+            <revision>
+                <revnumber>5.5.1</revnumber>
+                <revremark>Second output argument removed.</revremark>
+            </revision>
         </revhistory>
     </refsection>
 </refentry>
index d13d126..b9aa495 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>呼び出し手順</title>
-        <synopsis>[param_list,err] = add_param(list_name,param_name,param_value)</synopsis>
+        <synopsis>param_list = add_param(list_name,param_name,param_value)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>引数</title>
                     </para>
                 </listitem>
             </varlistentry>
-            <varlistentry>
-                <term>err</term>
-                <listitem>
-                    <para>エラーフラグで,list_nameがplist型でない
-                        (このリストはinit_paramをコールすることにより初期化されていない)
-                        場合 %T に設定されます.
-                    </para>
-                </listitem>
-            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
@@ -74,7 +65,7 @@
     </refsection>
     <refsection>
         <title>例</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 mylist = init_param();
 mylist = add_param(mylist,'minbound',[0 0 0]);
  ]]></programlisting>
index 9c2f2ce..5581dba 100644 (file)
@@ -7,7 +7,7 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 
-function [plist, err] = add_param(list_name, param_name, param_value)
+function plist = add_param(list_name, param_name, param_value)
 
     [nargout, nargin] = argn();
 
@@ -23,9 +23,6 @@ function [plist, err] = add_param(list_name, param_name, param_value)
     if typeof(list_name) == "plist" then
         if ~is_param(list_name, param_name) then
             setfield(1, [getfield(1, list_name) param_name], list_name);
-            if nargout == 2 then
-                err = %F;
-            end
             if nargin == 3 then
                 list_name(param_name) = param_value;
             end
@@ -33,9 +30,6 @@ function [plist, err] = add_param(list_name, param_name, param_value)
             error(sprintf(gettext("%s: Wrong value for input argument #%d: key ""%s"" already defined.\n"), "add_param", 2, param_name));
         end
     else
-        if nargout == 2 then
-            err = %T;
-        end
         error(sprintf(gettext("%s: Wrong type for input argument #%d: %s expected.\n"), "add_param", 1, "plist"));
     end
     plist = list_name;