</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
- <synopsis>vars=macrovar(function)</synopsis>
+ <synopsis>vars = macrovar(function)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<term>vars</term>
<listitem>
<para>
- list <literal>list(in,out,nolocal,called,locals)</literal>
+ list, <literal>list(in, out, nolocal, called, locals)</literal>
</para>
</listitem>
</varlistentry>
<title>Description</title>
<para>
Returns in a list the set of variables used by a function.
- <literal>vars</literal> is a list made of five column vectors of character strings
- </para>
- <para>
- <literal>in</literal> input variables (<literal>vars(1)</literal>)
- </para>
- <para>
- <literal>out</literal> output variables (<literal>vars(2)</literal>)
- </para>
- <para>
- <literal>nolocal</literal>referenced variables which are not defined inside the function and which are not functions (<literal>vars(3)</literal>)
- </para>
- <para>
- <literal>called</literal> names of functions called (<literal>vars(4)</literal>)
- </para>
- <para>
- <literal>locals</literal> local variables (<literal>vars(5)</literal>)
+ <literal>vars</literal> is a list made of five column vectors of character strings:
</para>
+ <simplelist type="inline">
+ <member>
+ <literal>in</literal>: input variables (<literal>vars(1)</literal>)
+ </member>
+ <member>
+ <literal>out</literal>: output variables (<literal>vars(2)</literal>)
+ </member>
+ <member>
+ <literal>nolocal</literal>: referenced variables which are not defined inside the function and which are not functions (<literal>vars(3)</literal>)
+ </member>
+ <member>
+ <literal>called</literal>: names of functions called (<literal>vars(4)</literal>)
+ </member>
+ <member>
+ <literal>locals</literal>: local variables (<literal>vars(5)</literal>)
+ </member>
+ </simplelist>
</refsection>
<refsection>
<title>Examples</title>
- <programlisting role="example"><![CDATA[
-deff('y=f(x1,x2)','loc=1;y=a*x1+x2-loc')
-vars=macrovar(f)
+ <programlisting role="example"><![CDATA[
+deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc');
+vars = macrovar(f)
]]></programlisting>
</refsection>
<refsection role="see also">
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution. The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="macrovar">
+ <refnamediv>
+ <refname>macrovar</refname>
+ <refpurpose>variables d'une fonction</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>Séquence d'appel</title>
+ <synopsis>vars = macrovar(fonction)</synopsis>
+ </refsynopsisdiv>
+ <refsection>
+ <title>Paramètres</title>
+ <variablelist>
+ <varlistentry>
+ <term>vars</term>
+ <listitem>
+ <para>
+ liste, <literal>list(in, out, nolocal, called, locals)</literal>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>fonction</term>
+ <listitem>
+ <para>nom de la fonction</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ <refsection>
+ <title>Description</title>
+ <para>
+ Retourne dans une liste l'ensemble des variables utilisées par une fonction.
+ <literal>vars</literal> est une liste de cinq vecteurs colonnes de chaînes de caractères:
+ </para>
+ <simplelist type="inline">
+ <member>
+ <literal>in</literal>: paramètres d'entrée (<literal>vars(1)</literal>)
+ </member>
+ <member>
+ <literal>out</literal>: paramètres de sortie (<literal>vars(2)</literal>)
+ </member>
+ <member>
+ <literal>nolocal</literal>: variables référencées qui ne sont pas définies dans la fonction et qui ne sont pas des fonctions (<literal>vars(3)</literal>)
+ </member>
+ <member>
+ <literal>called</literal>: noms des fonctions appelées (<literal>vars(4)</literal>)
+ </member>
+ <member>
+ <literal>locals</literal>: variables locales (<literal>vars(5)</literal>)
+ </member>
+ </simplelist>
+ </refsection>
+ <refsection>
+ <title>Exemples</title>
+ <programlisting role="example"><![CDATA[
+deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc');
+vars = macrovar(f)
+ ]]></programlisting>
+ </refsection>
+ <refsection role="see also">
+ <title>Voir Aussi</title>
+ <simplelist type="inline">
+ <member>
+ <link linkend="string">string</link>
+ </member>
+ <member>
+ <link linkend="macr2lst">macr2lst</link>
+ </member>
+ </simplelist>
+ </refsection>
+</refentry>