* Bug #7047 fixed - milk_drop added to the demos gui 11/12811/3
Paul BIGNIER [Thu, 3 Oct 2013 13:59:43 +0000 (15:59 +0200)]
milk_drop does not really have a reason to be integrated in Scilab if it is not on display.

Change-Id: I4edb497839b82e53558b310477cea799a1597156

scilab/CHANGES_5.5.X
scilab/modules/graphics/demos/basic_functions/basic_functions.dem.gateway.sce
scilab/modules/graphics/demos/basic_functions/basic_functions_9.dem.sce [new file with mode: 0644]
scilab/modules/graphics/help/en_US/3d_plot/milk_drop.xml
scilab/modules/graphics/macros/milk_drop.sci

index 596c2fe..cbcfd49 100644 (file)
@@ -6,6 +6,8 @@ Scilab Bug Fixes
 
 * Bug #5016 fixed - condestsp could return different results when repeated calls were performed.
 
+* Bug #7047 fixed - milk_drop is now obsolete. It will be removed in Scilab 5.5.1, but will be kept as a demo.
+
 * Bug #7570 fixed - The switch criterion on x and y is now explicited in beta() help page.
 
 * Bug #7705 fixed - In the Genetic algorithms help pages, documented the
@@ -272,6 +274,8 @@ Obsolete & Removed Functions
 * fprintf removed, please use mfprintf for files opened with mopen or write for files
   opened with file instead.
 
+* milk_drop tagged as obsolete. Will be removed in Scilab 5.5.1.
+
 
 Scilab Bug Fixes
 ================
index b5622e2..fedd8f0 100644 (file)
@@ -13,7 +13,8 @@ subdemolist=[
 "Set of rectangles"                                ,"basic_functions_5.dem.sce" ; ..
 "Colored matrix"                                   ,"basic_functions_6.dem.sce" ; ..
 "Colored histogram"                                ,"basic_functions_7.dem.sce" ; ..
-"Pie Chart"                                        ,"basic_functions_8.dem.sce" ]
+"Pie Chart"                                        ,"basic_functions_8.dem.sce" ; ..
+"Milk Drop"                                        ,"basic_functions_9.dem.sce" ]
 
 subdemolist(:,2) = demopath + subdemolist(:,2);
-clear demopath;
\ No newline at end of file
+clear demopath;
diff --git a/scilab/modules/graphics/demos/basic_functions/basic_functions_9.dem.sce b/scilab/modules/graphics/demos/basic_functions/basic_functions_9.dem.sce
new file mode 100644 (file)
index 0000000..85dd254
--- /dev/null
@@ -0,0 +1,27 @@
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
+//
+// This file is released under the 3-clause BSD license. See COPYING-BSD.
+
+function demo_basic_functions9()
+
+    mode(-1);
+
+    my_handle             = scf(100001);
+    clf(my_handle,"reset");
+    demo_viewCode("basic_functions_9.dem.sce");
+    my_plot_desc          = "milk drop";
+    my_handle.figure_name = my_plot_desc;
+
+    expr=[
+    "x = -2:0.1:2;"
+    "y = x;"
+    "z = eval3d(milk_drop, x, y);"
+    "plot3d(x, y, z)"];
+    execstr(expr);
+    // DEMO END
+
+endfunction
+
+demo_basic_functions9();
+clear demo_basic_functions9;
index 03c31e7..0c47971 100644 (file)
@@ -2,18 +2,20 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA - Serge Steer
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="milk_drop">
     <refnamediv>
         <refname>milk_drop</refname>
-        <refpurpose>Milk drop 3D function</refpurpose>
+        <refpurpose>
+            Milk drop 3D function. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
     </refsection>
     <refsection>
         <title>Description</title>
+        <warning>
+            This function is obsolete.
+            It will be permanently removed in Scilab 5.5.1
+        </warning>
         <para>
             <literal>milk_drop</literal> is a function representing the surface of a milk drop
-            falling down into milk. It
-            can be used to test functions <literal>eval3d</literal> and <literal>plot3d</literal>.
+            falling down into milk. It can be used to test functions
+            <literal>eval3d</literal> and <literal>plot3d</literal>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 x=-2:0.1:2;
 y=x;
 z=eval3d(milk_drop,x,y);
@@ -69,4 +75,15 @@ plot3d(x,y,z)
             </member>
         </simplelist>
     </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.5.0</revnumber>
+                <revdescription>
+                    Function tagged as obsolete. Will be removed in 5.5.1.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 6cfaf49..5c5ffad 100644 (file)
@@ -7,6 +7,7 @@
 // http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 
 function [z]=milk_drop(x,y)
+    warnobsolete(scilabRemovedVersion="5.5.1");
 
     if argn(2)<>2 then
         error(msprintf(gettext("%s: Wrong number of input argument(s): %d expected.\n"), "milk_drop", 2));