← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/parameters/help/en_US/init_param.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/parameters/help/en_US/init_param.xml
11
11
 *
12
12
 -->
13
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:ns3="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="init_param" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>init_param</refname>
16
 
    <refpurpose>Initialize the structure which will handles the parameters
17
 
      list
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>param_list = init_param(['param_name1',param_value1,...])</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>param_list</term>
29
 
        <listitem>
30
 
          <para>an initialized list of parameters (if no input
31
 
            parameters are shipped, this list is empty and is
32
 
            of type plist).
33
 
          </para>
34
 
        </listitem>
35
 
      </varlistentry>
36
 
    </variablelist>
37
 
  </refsection>
38
 
  <refsection>
39
 
    <title>Description</title>
40
 
    <para>This function initialize an empty list of parameters. You must
41
 
      initialize the list of parameters before using it.
42
 
    </para>
43
 
  </refsection>
44
 
  <refsection>
45
 
    <title>Examples</title>
46
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>init_param</refname>
 
16
        <refpurpose>Initialize the structure which will handles the parameters
 
17
            list
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>param_list = init_param(['param_name1',param_value1,...])</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>param_list</term>
 
29
                <listitem>
 
30
                    <para>an initialized list of parameters (if no input
 
31
                        parameters are shipped, this list is empty and is
 
32
                        of type plist).
 
33
                    </para>
 
34
                </listitem>
 
35
            </varlistentry>
 
36
        </variablelist>
 
37
    </refsection>
 
38
    <refsection>
 
39
        <title>Description</title>
 
40
        <para>This function initialize an empty list of parameters. You must
 
41
            initialize the list of parameters before using it.
 
42
        </para>
 
43
    </refsection>
 
44
    <refsection>
 
45
        <title>Examples</title>
 
46
        <programlisting role="example"><![CDATA[ 
47
47
// Creation of an empty plist
48
48
mylist = init_param();
49
49
mylist = add_param(mylist,'minbound',[0 0 0]);
51
51
// Creation of a pre-filled plist
52
52
mylist_2 = init_param('minbound', [0 0 0], 'maxbound', [1 1 1]);
53
53
 ]]></programlisting>
54
 
  </refsection>
55
 
  <refsection role="see also">
56
 
    <title>See Also</title>
57
 
    <simplelist type="inline">
58
 
      <member>
59
 
        <link linkend="add_param">add_param</link>
60
 
      </member>
61
 
      <member>
62
 
        <link linkend="set_param">set_param</link>
63
 
      </member>
64
 
      <member>
65
 
        <link linkend="get_param">get_param</link>
66
 
      </member>
67
 
      <member>
68
 
        <link linkend="remove_param">remove_param</link>
69
 
      </member>
70
 
      <member>
71
 
        <link linkend="is_param">is_param</link>
72
 
      </member>
73
 
    </simplelist>
74
 
  </refsection>
 
54
    </refsection>
 
55
    <refsection role="see also">
 
56
        <title>See Also</title>
 
57
        <simplelist type="inline">
 
58
            <member>
 
59
                <link linkend="add_param">add_param</link>
 
60
            </member>
 
61
            <member>
 
62
                <link linkend="set_param">set_param</link>
 
63
            </member>
 
64
            <member>
 
65
                <link linkend="get_param">get_param</link>
 
66
            </member>
 
67
            <member>
 
68
                <link linkend="remove_param">remove_param</link>
 
69
            </member>
 
70
            <member>
 
71
                <link linkend="is_param">is_param</link>
 
72
            </member>
 
73
        </simplelist>
 
74
    </refsection>
75
75
</refentry>