[doc] misc. fix & improvements
[scilab.git] / scilab / modules / external_objects_java / help / en_US / jenableTrace.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="jenableTrace">
19     <refnamediv>
20         <refname>jenableTrace</refname>
21         <refpurpose>Allow to trace the internal functionality of JIMS to help the debugging.</refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>
26             jenableTrace(filename)
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Parameters</title>
31         <variablelist>
32             <varlistentry>
33                 <term>filename</term>
34                 <listitem>
35                     <para>A string giving the filename</para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39     </refsection>
40     <refsection>
41         <title>Description</title>
42         <para>
43             Make easier the debugging in tracing what it happens in JIMS. It is common way to help the author to debug.
44         </para>
45     </refsection>
46     <refsection>
47         <title>Examples</title>
48         <programlisting role="example"><![CDATA[
49                jenableTrace(fullpath(TMPDIR + "/../debug_jims.log"));
50                // ...
51                jdisableTrace();
52       ]]></programlisting>
53     </refsection>
54     <refsection role="see also">
55         <title>See also</title>
56         <simplelist type="inline">
57             <member>
58                 <link linkend="jdisableTrace">jdisableTrace</link>
59             </member>
60         </simplelist>
61     </refsection>
62     <refsection>
63         <title>History</title>
64         <revhistory>
65             <revision>
66                 <revnumber>5.5.0</revnumber>
67                 <revremark>
68                     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.
69                 </revremark>
70             </revision>
71         </revhistory>
72     </refsection>
73 </refentry>
74