example_run() function: test the examples of the help pages
[scilab.git] / scilab / modules / development_tools / help / en_US / example_run.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) 2012 - Scilab Enterprises - Vincent COUVERT
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="example_run" xml:lang="en">
14   <refnamediv>
15     <refname>example_run</refname>
16     <refpurpose>Launch the examples found in help pages.</refpurpose>
17   </refnamediv>
18   <refsynopsisdiv>
19     <title>Calling Sequence</title>
20     <synopsis>
21       example_run()
22       example_run(moduleNames)
23       example_run(moduleNames, functionNames)
24       example_run(moduleNames, functionNames, language)
25       example_run(moduleNames, functionNames, language, testrunOptions, testrunExportToFile)
26     </synopsis>
27   </refsynopsisdiv>
28   <refsection>
29     <title>Arguments</title>
30     <variablelist>
31       <varlistentry>
32         <term>moduleNames</term>
33         <listitem>
34           <para>
35             a string or a string vector: the name(s) of the modules to test. Default value is the value returned by <link linkend="getmodules">getmodules()</link>.
36           </para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>functionNames</term>
41         <listitem>
42           <para>a string or a string vector: the name(s) of the functions to test. If not given, all help pages of the module(s) will be tested.</para>
43         </listitem>
44       </varlistentry>
45       <varlistentry>
46         <term>language</term>
47         <listitem>
48           <para>a string: the language of the help pages to test. Default value is "en_US".</para>
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term>testrunOptions</term>
53         <listitem>
54           <para>
55             Used as third input argument for <link linkend="test_run">test_run</link>.
56           </para>
57         </listitem>
58       </varlistentry>
59       <varlistentry>
60         <term>testrunExportToFile</term>
61         <listitem>
62           <para>
63             Used as forth input argument for <link linkend="test_run">test_run</link>.
64           </para>
65         </listitem>
66       </varlistentry>
67     </variablelist>
68   </refsection>
69   <refsection>
70     <title>Description</title>
71     <para>
72       This function extracts the examples given in help pages and run them using <link linkend="test_run">test_run</link>.
73     </para>
74   </refsection>
75   <refsection>
76     <title>Example</title>
77     <programlisting role="example"><![CDATA[
78 example_run("core")
79 example_run("core", "argn")
80 example_run("core", ["argn"; "mode"])
81 example_run("core", "argn", "en_US")
82  ]]></programlisting>
83   </refsection>
84   <refsection role="see also">
85     <title>See Also</title>
86     <simplelist type="inline">
87       <member>
88         <link linkend="test_run">test_run</link>
89       </member>
90     </simplelist>
91   </refsection>
92   <refsection>
93     <title>History</title>
94     <revhistory>
95       <revision>
96         <revnumber>5.4.0</revnumber>
97         <revremark>Function example_run introduced.</revremark>
98       </revision>
99     </revhistory>
100   </refsection>
101 </refentry>