* Bug 14585: editvar(close) replaces closeEditvar()
[scilab.git] / scilab / modules / ui_data / help / en_US / closeEditvar.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2013 - Scilab Enterprises - Calixte Denizet
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="en" xml:id="closeEditvar">
20     <refnamediv>
21         <refname>closeEditvar</refname>
22         <refpurpose>Close the variable editor <emphasis role="bold">(obsolete)</emphasis></refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Syntax</title>
26         <synopsis>closeEditvar</synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Description</title>
30         <warning>
31             <para>
32                 <literal>closeEditvar()</literal> will be removed in Scilab 6.1.x Please use
33                 <literal>editvar("close")</literal> instead.
34             </para>
35         </warning>
36         <para>
37             <literal>closeEditvar</literal> closes the variable editor.
38         </para>
39     </refsection>
40     <refsection>
41         <title>Examples</title>
42         <programlisting role="example"><![CDATA[
43 a=rand(10,10);
44 editvar a;
45 closeEditvar();
46  ]]></programlisting>
47     </refsection>
48     <refsection role="see also">
49         <title>See also</title>
50         <simplelist type="inline">
51             <member>
52                 <link linkend="editvar">editvar</link>
53             </member>
54         </simplelist>
55     </refsection>
56     <refsection>
57         <title>History</title>
58         <revhistory>
59             <revision>
60                 <revnumber>5.4.1</revnumber>
61                 <revremark>
62                     Function <literal>closeEditvar()</literal> introduced
63                 </revremark>
64             </revision>
65             <revision>
66                 <revnumber>6.1.0</revnumber>
67                 <revremark>
68                     Function tagged obsolete.
69                 </revremark>
70             </revision>
71         </revhistory>
72     </refsection>
73
74 </refentry>