improve the documentation of the parameters module
[scilab.git] / scilab / modules / parameters / help / en_US / init_param.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) 2008 - Yann COLLETTE <yann.collette@renault.com>
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="init_param" 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>23-Aug-2007</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>init_param</refname>
26
27     <refpurpose>Initialize the structure which will handles the parameters
28     list</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>param_list = init_param()</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>param_list</term>
43
44         <listitem>
45           <para>an initialized list of parameters (this list is empty and is
46           of type plist).</para>
47         </listitem>
48       </varlistentry>
49     </variablelist>
50   </refsection>
51
52   <refsection>
53     <title>Description</title>
54         <para>This function initialize an empty list of parameters. You must
55         initialize the list of parameters before using it.</para>
56   </refsection>
57
58   <refsection>
59     <title>Examples</title>
60
61     <programlisting role="example">
62    mylist = init_param();
63    mylist = add_param(mylist,'minbound',[0 0 0]);
64   </programlisting>
65   </refsection>
66
67   <refsection>
68     <title>See Also</title>
69
70     <simplelist type="inline">
71       <member><link linkend="add_param"> add_param </link></member>
72
73       <member><link linkend="set_param"> set_param </link></member>
74
75       <member><link linkend="get_param"> get_param </link></member>
76
77       <member><link linkend="remove_param"> remove_param </link></member>
78
79       <member><link linkend="is_param"> is_param </link></member>
80     </simplelist>
81   </refsection>
82
83   <refsection>
84     <title>Authors</title>
85
86     <variablelist>
87       <varlistentry>
88         <term>collette</term>
89
90         <listitem>
91           <para>ycollet@freesurf.fr</para>
92         </listitem>
93       </varlistentry>
94     </variablelist>
95   </refsection>
96 </refentry>