atomsCheckModule function added. (SEP 76)
[scilab.git] / scilab / modules / atoms / help / en_US / atomsCheckModule.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) 2011 DIGITEO - Allan CORNET
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 version="5.0-subset Scilab" xml:id="atomsCheckModule" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate$</pubdate>
22   </info>
23   
24   <refnamediv>
25     <refname>atomsCheckModule</refname>
26     
27     <refpurpose>Check the given list of ATOMS modules</refpurpose>
28   </refnamediv>
29   
30   <refsynopsisdiv>
31     <title>Calling Sequence</title>
32     
33     <synopsis>
34       isok = atomsCheckModule(modulenames)
35       isok = atomsCheckModule(modulenames, bVerbose)
36     </synopsis>
37   </refsynopsisdiv>
38   
39   <refsection>
40     <title>Arguments</title>
41     
42     <variablelist>
43       <varlistentry>
44         <term>modulenames</term>
45         
46         <listitem>
47           <para>mxn matrix of strings: the names of the modules to check</para>
48         </listitem>
49       </varlistentry>
50       
51       <varlistentry>
52         <term>bVerbose</term>
53         
54         <listitem>
55           <para>a 1-by-1 matrix of booleans, set to true to display
56             messages
57           </para>
58         </listitem>
59       </varlistentry>
60     </variablelist>
61   </refsection>
62   
63   <refsection>
64     <title>Description</title>
65     
66     <para>
67       <literal>atomsCheckModule</literal> Installs, loads, launches the tests
68       and removes all the modules listed in <literal>modulenames</literal>.
69     </para>
70   </refsection>
71   
72   <refsection>
73     <title>Example</title>
74     
75     <programlisting role="example">  atomsCheckModule("scibench")
76       atomsCheckModule(["apifun" "scibench"],%t)
77     </programlisting>
78   </refsection>
79   
80   <refsection role="see also">
81     <title>See Also</title>
82     
83     <simplelist type="inline">
84       <member>
85         <link linkend="atomsTest">atomsTest</link>
86       </member>
87       
88       <member>
89         <link linkend="test_run">test_run</link>
90       </member>
91       
92       <member>
93         <link linkend="assert_overview">assert</link>
94       </member>
95     </simplelist>
96   </refsection>
97   <refsection>
98     <title>History</title>
99     <revhistory>
100       <revision>
101         <revnumber>5.4.0</revnumber>
102         <revremark>This function was added in Scilab 5.4.0</revremark>
103       </revision>
104     </revhistory>
105   </refsection>
106 </refentry>