* Bug #11924 fixed - winclose() was not tagged as obsolete. 24/10724/3
Charlotte HECQUET [Thu, 7 Mar 2013 10:41:45 +0000 (11:41 +0100)]
Change-Id: I8d8266caa022b5a3480c27059e78f7068225ac9d

scilab/CHANGES_5.4.X
scilab/modules/gui/help/en_US/close.xml
scilab/modules/gui/help/en_US/progressionbar.xml
scilab/modules/gui/help/en_US/waitbar.xml
scilab/modules/tclsci/help/en_US/winclose.xml

index 1cf1360..34097b9 100644 (file)
@@ -315,6 +315,8 @@ Bug fixes
 
 * Bug #11851 fixed - Default EOL under Mac should be LF.
 
+* Bug #11924 fixed - winclose() was not tagged as obsolete.
+
 * Bug #11931 fixed - In graphics, white space was not used as default thousand
                      separator.
 
index 0eece58..f0cd445 100644 (file)
@@ -2,7 +2,7 @@
 <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="close">
     <refnamediv>
         <refname>close</refname>
-        <refpurpose>close a figure</refpurpose>
+        <refpurpose>close a figure or a window</refpurpose>
     </refnamediv>
     <refsection>
         <title>Arguments</title>
@@ -10,7 +10,7 @@
             <varlistentry>
                 <term>h</term>
                 <listitem>
-                    <para>integer Handle of the window to close.</para>
+                    <para>integer Handle or window identification of the window to close.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -18,8 +18,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            This routine close a tksci figure (toplevel window). If a handle is
-            given, the figure corresponding to this handle is closed.
+            This routine close a tksci figure (toplevel window). If a handle 
+            (resp. window identification) is given, the figure (resp. window)
+            corresponding to this handle (resp. window identification) is closed.
             Otherwise, the current (active) figure is closed.
         </para>
     </refsection>
@@ -42,6 +43,10 @@ close();
 // close the current graphic window (ie fig. 2)
 close(h);
 // close figure 1
+wid1=progressionbar("Message");
+// create a progression bar
+close(wid1);
+// close this window
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index d1d814a..f74e5e2 100644 (file)
@@ -56,7 +56,7 @@ for j=0:0.1:1,
   realtime(3*j);
   progressionbar(winId);
 end
-winclose(winId);
+close(winId);
  ]]></programlisting>
     </refsection>
 </refentry>
index 8b83fb8..de6fcdf 100644 (file)
@@ -75,7 +75,7 @@ for j=0:0.1:1,
   realtime(3*j);
   waitbar(j,winH);
 end
-winclose(winH);
+close(winH);
  ]]></programlisting>
     </refsection>
 </refentry>
index 505bfcf..d522631 100644 (file)
@@ -14,7 +14,9 @@
 <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="winclose">
     <refnamediv>
         <refname>winclose</refname>
-        <refpurpose>close windows created by sciGUI</refpurpose>
+        <refpurpose>
+            close windows created by sciGUI. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -35,6 +37,8 @@
         <title>Description</title>
         <para>
             <literal>winclose(winIds)</literal> close windows created by sciGUI.
+            <warning>This function is obsolete.</warning>
+            It is better to use <link linkend="close">close</link> instead of <literal>winclose</literal>.
         </para>
     </refsection>
     <refsection>