improve the documentation of the parameters module
Yann Collette [Mon, 6 Jul 2009 11:10:14 +0000 (13:10 +0200)]
scilab/modules/parameters/help/en_US/add_param.xml
scilab/modules/parameters/help/en_US/get_param.xml
scilab/modules/parameters/help/en_US/init_param.xml
scilab/modules/parameters/help/en_US/is_param.xml
scilab/modules/parameters/help/en_US/list_param.xml
scilab/modules/parameters/help/en_US/remove_param.xml
scilab/modules/parameters/help/en_US/set_param.xml

index 85003a2..5a73b6a 100644 (file)
@@ -22,7 +22,7 @@
   </refnamediv>
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>[ga_list,err] = add_param(list_name,param_name,param_value)</synopsis>
+    <synopsis>[param_list,err] = add_param(list_name,param_name,param_value)</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Parameters</title>
@@ -49,7 +49,7 @@
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>ga_list</term>
+        <term>param_list</term>
         <listitem>
           <para>the updated list of parameters.
        </para>
   </refsection>
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
         <para>
       This function creates a new parameter in a list of parameters. You can set the value of the parameter using this function or you can set it via a call to set_param.
      </para>
-      </listitem>
-    </itemizedlist>
   </refsection>
   <refsection>
     <title>Examples</title>
index 22610f7..8de0198 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="get_param">
+<refentry version="5.0-subset Scilab" xml:id="get_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>get_param</refname>
-    <refpurpose> Get the value of a parameter in a parameter list </refpurpose>
+
+    <refpurpose>Get the value of a parameter in a parameter list</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>[res,err] = get_param(list_name,param_name)</synopsis>
+
+    <synopsis>[res,err] = get_param(list_name,param_name,default_value)</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>list_name</term>
+
         <listitem>
-          <para>the list of parameters. This list must have been initialize by a call to init_param.
-       </para>
+          <para>the list of parameters. This list must have been initialized
+          by a call to init_param.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>param_name</term>
+
         <listitem>
-          <para>a string. The name of the parameter to be add in the list of parameters.
-       </para>
+          <para>a string. The name of the parameter to be add in the list of
+          parameters.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term>default_value</term>
+
+        <listitem>
+          <para>the default value to be stored in the parameter if param_name
+          has not been found.</para>
+        </listitem>
+      </varlistentry>
+
       <varlistentry>
         <term>res</term>
+
         <listitem>
-          <para>the value of the parameter. If the parameter doesn't exist, res = [].
-       </para>
+          <para>the value of the parameter. If the parameter doesn't exist,
+          res = [].</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>err</term>
+
         <listitem>
-          <para>an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).
-       </para>
+          <para>an error flag which is set to %T if list_name is not of type
+          plist (this list hasn't been initialized by a call to
+          init_param).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      This function returns the value of the parameter param_name in a parameter list.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>This function returns the value of the parameter param_name in a
+        parameter list. If the err output parameter is not present, when an
+        error occurs, a message is printed in the console.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
-   mylist = init_param();
-   mylist = add_param(mylist,'minbound',[0 0 0]);
-   disp(get_param(mylist,'minbound'));
-  ]]></programlisting>
+
+    <programlisting role="example">
+mylist = init_param();
+mylist = add_param(mylist,'minbound',[0 0 0]);
+disp(get_param(mylist,'minbound',-[1 1 1]));
+disp(get_param(mylist,'maxbound', [1 1 1]));
+ </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="init_param"> init_param </link>
-      </member>
-      <member>
-        <link linkend="set_param"> set_param </link>
-      </member>
-      <member>
-        <link linkend="add_param"> add_param </link>
-      </member>
-      <member>
-        <link linkend="remove_param"> remove_param </link>
-      </member>
-      <member>
-        <link linkend="is_param"> is_param </link>
-      </member>
+      <member><link linkend="init_param"> init_param </link></member>
+
+      <member><link linkend="set_param"> set_param </link></member>
+
+      <member><link linkend="add_param"> add_param </link></member>
+
+      <member><link linkend="remove_param"> remove_param </link></member>
+
+      <member><link linkend="is_param"> is_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 5af2dd7..5a69e82 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="init_param">
+<refentry version="5.0-subset Scilab" xml:id="init_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>init_param</refname>
-    <refpurpose> Initialize the structure which will handles the parameters list</refpurpose>
+
+    <refpurpose>Initialize the structure which will handles the parameters
+    list</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>ga_list = init_param()</synopsis>
+
+    <synopsis>param_list = init_param()</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
-        <term>ga_list</term>
+        <term>param_list</term>
+
         <listitem>
-          <para>an initialized list of parameters (this list is empty and is of type plist).
-       </para>
+          <para>an initialized list of parameters (this list is empty and is
+          of type plist).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      This function initialize an empty list of parameters. You must initialize the list of parameters before using it.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>This function initialize an empty list of parameters. You must
+        initialize the list of parameters before using it.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
    mylist = init_param();
    mylist = add_param(mylist,'minbound',[0 0 0]);
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="add_param"> add_param </link>
-      </member>
-      <member>
-        <link linkend="set_param"> set_param </link>
-      </member>
-      <member>
-        <link linkend="get_param"> get_param </link>
-      </member>
-      <member>
-        <link linkend="remove_param"> remove_param </link>
-      </member>
-      <member>
-        <link linkend="is_param"> is_param </link>
-      </member>
+      <member><link linkend="add_param"> add_param </link></member>
+
+      <member><link linkend="set_param"> set_param </link></member>
+
+      <member><link linkend="get_param"> get_param </link></member>
+
+      <member><link linkend="remove_param"> remove_param </link></member>
+
+      <member><link linkend="is_param"> is_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>
index a852e12..c80e793 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="is_param">
+<refentry version="5.0-subset Scilab" xml:id="is_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>is_param</refname>
-    <refpurpose> Check if a parameter is present in a parameter list </refpurpose>
+
+    <refpurpose>Check if a parameter is present in a parameter
+    list</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[res,err] = is_param(list_name,param_name)</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>list_name</term>
+
         <listitem>
-          <para>the list of parameters. This list must have been initialize by a call to init_param.
-       </para>
+          <para>the list of parameters. This list must have been initialize by
+          a call to init_param.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>param_name</term>
+
         <listitem>
-          <para>a string. The name of the parameter to be add in the list of parameters.
-       </para>
+          <para>a string. The name of the parameter to be add in the list of
+          parameters.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>res</term>
+
         <listitem>
-          <para>the result: %T is the parameter is present, %F otherwise.
-       </para>
+          <para>the result: %T is the parameter is present, %F
+          otherwise.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>err</term>
+
         <listitem>
-          <para>an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).
-       </para>
+          <para>an error flag which is set to %T if list_name is not of type
+          plist (this list hasn't been initialized by a call to
+          init_param).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      This function checks if a parameter is present in a parameter list.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>This function checks if a parameter is present in a parameter
+        list. If the err output parameter is not present, when an error
+        occurs, a message is printed in the console.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
    mylist = init_param();
    mylist = add_param(mylist,'minbound',[0 0 0]);
    disp(is_param(mylist,'minbound'));
    disp(is_param(mylist,'maxbound'));
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="init_param"> init_param </link>
-      </member>
-      <member>
-        <link linkend="set_param"> set_param </link>
-      </member>
-      <member>
-        <link linkend="get_param"> get_param </link>
-      </member>
-      <member>
-        <link linkend="remove_param"> remove_param </link>
-      </member>
-      <member>
-        <link linkend="add_param"> add_param </link>
-      </member>
+      <member><link linkend="init_param"> init_param </link></member>
+
+      <member><link linkend="set_param"> set_param </link></member>
+
+      <member><link linkend="get_param"> get_param </link></member>
+
+      <member><link linkend="remove_param"> remove_param </link></member>
+
+      <member><link linkend="add_param"> add_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>
index ce72f39..4c64ab9 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="list_param">
+<refentry version="5.0-subset Scilab" xml:id="list_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>list_param</refname>
-    <refpurpose> List all the parameters name in a list of parameters </refpurpose>
+
+    <refpurpose>List all the parameters name in a list of
+    parameters</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[string_list,err] = list_param(list_name)</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>list_name</term>
+
         <listitem>
-          <para>the list of parameters. This list must have been initialize by a call to init_param.
-       </para>
+          <para>the list of parameters. This list must have been initialize by
+          a call to init_param.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>string_list</term>
+
         <listitem>
-          <para>the list of parameters name.
-       </para>
+          <para>the list of parameters name.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>err</term>
+
         <listitem>
-          <para>an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).
-       </para>
+          <para>an error flag which is set to %T if list_name is not of type
+          plist (this list hasn't been initialized by a call to
+          init_param).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      List all the parameters name in a list of parameters.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>List all the parameters name in a list of parameters. If the err
+        output parameter is not present, when an error occurs, a message is
+        printed in the console.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
    mylist = init_param();
    mylist = add_param(mylist,'minbound',[0 0 0]);
    mylist = add_param(mylist,'maxbound',[1 1 1]);
    disp(list_param(mylist));
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="init_param"> init_param </link>
-      </member>
-      <member>
-        <link linkend="set_param"> set_param </link>
-      </member>
-      <member>
-        <link linkend="get_param"> get_param </link>
-      </member>
-      <member>
-        <link linkend="remove_param"> remove_param </link>
-      </member>
-      <member>
-        <link linkend="is_param"> is_param </link>
-      </member>
+      <member><link linkend="init_param"> init_param </link></member>
+
+      <member><link linkend="set_param"> set_param </link></member>
+
+      <member><link linkend="get_param"> get_param </link></member>
+
+      <member><link linkend="remove_param"> remove_param </link></member>
+
+      <member><link linkend="is_param"> is_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 1c0be8a..7d38915 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="remove_param">
+<refentry version="5.0-subset Scilab" xml:id="remove_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>remove_param</refname>
-    <refpurpose>  Remove a parameter and its associated value from a list of parameters </refpurpose>
+
+    <refpurpose>Remove a parameter and its associated value from a list of
+    parameters</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>[ga_list,err] = remove_param(list_name,param_name)</synopsis>
+
+    <synopsis>[param_list,err] = remove_param(list_name,param_name)</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>list_name</term>
+
         <listitem>
-          <para>the list of parameters. This list must have been initialize by a call to init_param.
-       </para>
+          <para>the list of parameters. This list must have been initialize by
+          a call to init_param.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>param_name</term>
+
         <listitem>
-          <para>a string. The name of the parameter to be removed from the list of parameters. If the parameter doesn't exist, nothing happens.
-       </para>
+          <para>a string. The name of the parameter to be removed from the
+          list of parameters. If the parameter doesn't exist, nothing
+          happens.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>ga_list</term>
+        <term>param_list</term>
+
         <listitem>
-          <para>the updated list of parameters.
-       </para>
+          <para>the updated list of parameters.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>err</term>
+
         <listitem>
-          <para>an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).
-       </para>
+          <para>an error flag which is set to %T if list_name is not of type
+          plist (this list hasn't been initialized by a call to
+          init_param).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      This function allows to remove a parameter and its associated value from a list of parameters.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>This function allows to remove a parameter and its associated
+        value from a list of parameters. If the err output parameter is not
+        present, when an error occurs, a message is printed in the
+        console.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
    mylist = init_param();
    mylist = add_param(mylist,'minbound',[0 0 0]);
    mylist = add_param(mylist,'maxbound',[0 0 0]);
    mylist = remove_param(mylist,'minbound');
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="init_param"> init_param </link>
-      </member>
-      <member>
-        <link linkend="set_param"> set_param </link>
-      </member>
-      <member>
-        <link linkend="get_param"> get_param </link>
-      </member>
-      <member>
-        <link linkend="add_param"> add_param </link>
-      </member>
-      <member>
-        <link linkend="is_param"> is_param </link>
-      </member>
+      <member><link linkend="init_param"> init_param </link></member>
+
+      <member><link linkend="set_param"> set_param </link></member>
+
+      <member><link linkend="get_param"> get_param </link></member>
+
+      <member><link linkend="add_param"> add_param </link></member>
+
+      <member><link linkend="is_param"> is_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>
index aaca95d..f43b128 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="set_param">
+<refentry version="5.0-subset Scilab" xml:id="set_param" xml:lang="en"
+          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">
   <info>
     <pubdate>23-Aug-2007</pubdate>
   </info>
+
   <refnamediv>
     <refname>set_param</refname>
-    <refpurpose> Set the value of a parameter in a parameter list </refpurpose>
+
+    <refpurpose>Set the value of a parameter in a parameter list</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>[ga_list,err] = set_param(list_name,param_name,param_value)</synopsis>
+
+    <synopsis>[param_list,err] = set_param(list_name,param_name,param_value)</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>list_name</term>
+
         <listitem>
-          <para>the list of parameters. This list must have been initialize by a call to init_param.
-       </para>
+          <para>the list of parameters. This list must have been initialize by
+          a call to init_param.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>param_name</term>
+
         <listitem>
-          <para>a string. The name of the parameter to be added in the list of parameters.
-       </para>
+          <para>a string. The name of the parameter to be added in the list of
+          parameters.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>param_value</term>
+
         <listitem>
-          <para>the value to be associated to the parameter param_name.
-       </para>
+          <para>the value to be associated to the parameter param_name.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>ga_list</term>
+        <term>param_list</term>
+
         <listitem>
-          <para>the updated list of parameters.
-       </para>
+          <para>the updated list of parameters.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>err</term>
+
         <listitem>
-          <para>an error flag which is set to %T if list_name is not of type plist (this list hasn't been initialized by a call to init_param).
-       </para>
+          <para>an error flag which is set to %T if list_name is not of type
+          plist (this list hasn't been initialized by a call to
+          init_param).</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-      This function sets the value of an already existing parameter. If the parameter doesn't exist, err is set to %T.
-     </para>
-      </listitem>
-    </itemizedlist>
+        <para>This function sets the value of an already existing parameter.
+        If the parameter doesn't exist, err is set to %T. If the err output
+        parameter is not present, when an error occurs, a message is printed
+        in the console.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
    mylist = init_param();
    mylist = add_param(mylist,'minbound',[0 0 0]);
    [mylist,err] = set_param(mylist,'minbound',[1 1 1]); disp(err);
    [mylist,err] = set_param(mylist,'maxbound',[1 1 1]); disp(err);
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="init_param"> init_param </link>
-      </member>
-      <member>
-        <link linkend="add_param"> add_param </link>
-      </member>
-      <member>
-        <link linkend="get_param"> get_param </link>
-      </member>
-      <member>
-        <link linkend="remove_param"> remove_param </link>
-      </member>
-      <member>
-        <link linkend="is_param"> is_param </link>
-      </member>
+      <member><link linkend="init_param"> init_param </link></member>
+
+      <member><link linkend="add_param"> add_param </link></member>
+
+      <member><link linkend="get_param"> get_param </link></member>
+
+      <member><link linkend="remove_param"> remove_param </link></member>
+
+      <member><link linkend="is_param"> is_param </link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Authors</title>
+
     <variablelist>
       <varlistentry>
         <term>collette</term>
+
         <listitem>
-          <para>
-    ycollet@freesurf.fr
-    </para>
+          <para>ycollet@freesurf.fr</para>
         </listitem>
       </varlistentry>
     </variablelist>