[doc] misc. fix & improvements
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jremove.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 *
4 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
6 *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15 *
16 *
17 -->
18 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="jremove">
19     <refnamediv>
20         <refname>jremove</refname>
21         <refpurpose>Remove a Java Object on the Java side</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             jremove()
27             jremove(varName_1 [, varName_2, ...])
28             jremove varName_1 [varName_2 ...]
29             jremove(object_1 [, object_2 ...])
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Parameters</title>
34         <variablelist>
35             <varlistentry>
36                 <term>varName_i</term>
37                 <listitem>
38                     <para>A string giving the variable name</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>object_i</term>
43                 <listitem>
44                     <para>A mlist typed _JObj or _JClass.</para>
45                 </listitem>
46             </varlistentry>
47         </variablelist>
48     </refsection>
49     <refsection>
50         <title>Description</title>
51         <para>
52             If no argument are given to jremove, then all the variables are removed on the Java side and garbage collection is called.
53         </para>
54         <para>
55             Else the corresponding variable is removed on the Java side.
56         </para>
57     </refsection>
58     <refsection>
59         <title>Examples</title>
60         <programlisting role="example"><![CDATA[
61                jimport java.lang.String;
62
63                s = String.new("Hello world");
64                jremove s;
65       ]]></programlisting>
66     </refsection>
67     <refsection role="see also">
68         <title>See also</title>
69         <simplelist type="inline">
70             <member>
71                 <link linkend="jexists">jexists</link>
72             </member>
73         </simplelist>
74     </refsection>
75     <refsection>
76         <title>History</title>
77         <revhistory>
78             <revision>
79                 <revnumber>5.5.0</revnumber>
80                 <revremark>
81                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
82                 </revremark>
83             </revision>
84         </revhistory>
85     </refsection>
86 </refentry>
87