add_param : Second output argument tagged as obsolete. 09/12709/3
Cedric Delamarre [Fri, 27 Sep 2013 14:04:37 +0000 (16:04 +0200)]
Change-Id: I575ae99de52d1ecb98a6947cb835bdd4b413ddb6

scilab/CHANGES_5.5.X
scilab/modules/parameters/help/en_US/add_param.xml
scilab/modules/parameters/macros/add_param.sci

index 8779a7b..88db933 100644 (file)
@@ -156,10 +156,12 @@ Obsolete & Removed Functions
 
 * chart tagged as obsolete. Will be removed in Scilab 5.5.1.
   Please use nicholschart instead.
-  
+
 * mvvacov tagged as obsolete. Will be removed in Scilab 6.0.0.
   Please use cov instead.
 
+* Second output argument of add_param tagged as obsolete. Will be removed in Scilab 5.5.1.
+
 * dft removed, please use fft instead.
 
 * sscanf removed, please use msscanf instead.
@@ -749,7 +751,7 @@ Scilab Bug Fixes
 
 
 Xcos Bug Fixes
-==============
+===============
 
 * Bug #7350 fixed - The I/O ports numbering of a superblock was not updated
                     when a new port was dropped.
index f1bb972..df03133 100644 (file)
@@ -55,6 +55,9 @@
                 <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>
@@ -67,7 +70,7 @@
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 mylist = init_param();
 mylist = add_param(mylist,'minbound',[0 0 0]);
  ]]></programlisting>
@@ -92,4 +95,13 @@ mylist = add_param(mylist,'minbound',[0 0 0]);
             </member>
         </simplelist>
     </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.5.0</revnumber>
+                <revremark>Second output argument (err) tagged as obsolete.</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 80964f9..9c2f2ce 100644 (file)
@@ -11,6 +11,11 @@ function [plist, err] = add_param(list_name, param_name, param_value)
 
     [nargout, nargin] = argn();
 
+    if nargout == 2 then
+        warning(sprintf(_("Second output argument of %s is obsolete.\n"), "add_param"))
+        warning(sprintf(_("This argument will be permanently removed in Scilab %s"), "5.5.1"))
+    end
+
     if nargin <> 2 & nargin <> 3 then
         error(sprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"), "add_param", 2, 3));
     end