Scicos MVC: minor comment fix
[scilab.git] / scilab / modules / io / help / en_US / getscilabkeywords.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) XXXX-2008 - INRIA
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.1-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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getscilabkeywords">
14     <refnamediv>
15         <refname>getscilabkeywords</refname>
16         <refpurpose>returns a list with all scilab
17             keywords.
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>list_keywords=getscilabkeywords()</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>list_keywords</term>
29                 <listitem>
30                     <para>a list</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>list_keywords(1) : primitives</para>
38         <para>list_keywords(2) : commands</para>
39         <para>list_keywords(3) : predef variables</para>
40         <para>list_keywords(4) :scilab functions</para>
41         <para>list_keywords(5) :xcos functions</para>
42     </refsection>
43     <refsection>
44         <title>Examples</title>
45         <programlisting role="example"><![CDATA[ 
46 list_keywords = getscilabkeywords();
47 primitives = list_keywords(1)
48 commands = list_keywords(2)
49 predef_var = list_keywords(3)
50 scilab_functions = list_keywords(4)
51 xcos_functions = list_keywords(5)
52  ]]></programlisting>
53     </refsection>
54 </refentry>