summaryrefslogtreecommitdiffstats
path: root/scilab/modules/data_structures
diff options
context:
space:
mode:
authorVincent Liard <vincent.liard@scilab.org>2010-05-06 15:26:27 +0200
committerYann Collette <yann.collette@scilab.org>2010-05-06 15:32:51 +0200
commit491c72f7c8b152db7b0ca44e117c1c4212d7e56a (patch)
treea1ffd0af4d08b0f25448695323aa4ce24ca44f80 /scilab/modules/data_structures
parent6f9ff76c71ed9e30a7a1f2717e49b6a26520f572 (diff)
downloadscilab-491c72f7c8b152db7b0ca44e117c1c4212d7e56a.zip
scilab-491c72f7c8b152db7b0ca44e117c1c4212d7e56a.tar.gz
bugfix 5609 fixed - fieldnames doc
Change-Id: I14554a54eb0ef24c734d56ad093f276b51026e4a
Diffstat (limited to 'scilab/modules/data_structures')
-rw-r--r--scilab/modules/data_structures/help/en_US/fieldnames.xml32
-rw-r--r--scilab/modules/data_structures/help/fr_FR/fieldnames.xml46
2 files changed, 49 insertions, 29 deletions
diff --git a/scilab/modules/data_structures/help/en_US/fieldnames.xml b/scilab/modules/data_structures/help/en_US/fieldnames.xml
index b87359f..a04da09 100644
--- a/scilab/modules/data_structures/help/en_US/fieldnames.xml
+++ b/scilab/modules/data_structures/help/en_US/fieldnames.xml
@@ -2,6 +2,7 @@
2<!-- 2<!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab 3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2006-2008 - INRIA 4 * Copyright (C) 2006-2008 - INRIA
5 * Copyright (C) 2010 - Digiteo - Vincent LIARD
5 * 6 *
6 * This file must be used under the terms of the CeCILL. 7 * 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 * This source file is licensed as described in the file COPYING, which
@@ -16,25 +17,25 @@
16 </info> 17 </info>
17 <refnamediv> 18 <refnamediv>
18 <refname>fieldnames</refname> 19 <refname>fieldnames</refname>
19 <refpurpose> returns the tlist, mlist or struct field names</refpurpose> 20 <refpurpose>get a tlist, mlist or struct fields names</refpurpose>
20 </refnamediv> 21 </refnamediv>
21 <refsynopsisdiv> 22 <refsynopsisdiv>
22 <title>Calling Sequence</title> 23 <title>Calling Sequence</title>
23 <synopsis>f=fieldnames(x)</synopsis> 24 <synopsis>f = fieldnames(lst)</synopsis>
24 </refsynopsisdiv> 25 </refsynopsisdiv>
25 <refsection> 26 <refsection>
26 <title>Parameters</title> 27 <title>Parameters</title>
27 <variablelist> 28 <variablelist>
28 <varlistentry> 29 <varlistentry>
29 <term>x</term> 30 <term>lst</term>
30 <listitem> 31 <listitem>
31 <para>a tlist or an mlist or a struct. </para> 32 <para>A tlist, mlist or struct variable.</para>
32 </listitem> 33 </listitem>
33 </varlistentry> 34 </varlistentry>
34 <varlistentry> 35 <varlistentry>
35 <term>f</term> 36 <term>f</term>
36 <listitem> 37 <listitem>
37 <para>column vector of strings</para> 38 <para>Strings column vector of fields names.</para>
38 </listitem> 39 </listitem>
39 </varlistentry> 40 </varlistentry>
40 </variablelist> 41 </variablelist>
@@ -42,18 +43,21 @@
42 <refsection> 43 <refsection>
43 <title>Description</title> 44 <title>Description</title>
44 <para> 45 <para>
45 This function returns the tlist, mlist, cell or struct field names.</para> 46 The <literal>fieldnames</literal> function returns field names
47 of a tlist, mlist or struct. As for Scilab 5.2,
48 <literal>fieldnames</literal> doesn't work on cells.
49 </para>
46 </refsection> 50 </refsection>
47 <refsection> 51 <refsection>
48 <title>Examples</title> 52 <title>Examples</title>
49 <programlisting role="example"><![CDATA[ 53 <programlisting role="example">
50clear t; 54fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
51t.a=1; 55fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
52t.b=2; 56fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
53fieldnames(t) 57obj.x = 3;
54fieldnames(1/%s) 58obj.y = 3;
55fieldnames(tf2ss(1/%s)) 59fieldnames(obj)
56 ]]></programlisting> 60 </programlisting>
57 </refsection> 61 </refsection>
58 <refsection> 62 <refsection>
59 <title>See Also</title> 63 <title>See Also</title>
diff --git a/scilab/modules/data_structures/help/fr_FR/fieldnames.xml b/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
index d0116cb..927ad82 100644
--- a/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
+++ b/scilab/modules/data_structures/help/fr_FR/fieldnames.xml
@@ -1,29 +1,41 @@
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2006-2008 - INRIA
5 * Copyright (C) 2010 - Digiteo - Vincent LIARD
6 *
7 * This file must be used under the terms of the CeCILL.
8 * This source file is licensed as described in the file COPYING, which
9 * you should have received as part of this distribution. The terms
10 * are also available at
11 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12 *
13 -->
2<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="fr" xml:id="fieldnames"> 14<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="fr" xml:id="fieldnames">
3 <info> 15 <info>
4 <pubdate>$LastChangedDate$</pubdate> 16 <pubdate>$LastChangedDate$</pubdate>
5 </info> 17 </info>
6 <refnamediv> 18 <refnamediv>
7 <refname>fieldnames</refname> 19 <refname>fieldnames</refname>
8 <refpurpose>returne les noms de champs d'une tlist, d'une mlist ou d'une struct</refpurpose> 20 <refpurpose>récure le nom des champs d'une tlist, d'une mlist ou d'une struct</refpurpose>
9 </refnamediv> 21 </refnamediv>
10 <refsynopsisdiv> 22 <refsynopsisdiv>
11 <title>Séquence d'appel</title> 23 <title>Séquence d'appel</title>
12 <synopsis>f=fieldnames(x)</synopsis> 24 <synopsis>f = fieldnames(lst)</synopsis>
13 </refsynopsisdiv> 25 </refsynopsisdiv>
14 <refsection> 26 <refsection>
15 <title>Paramètres</title> 27 <title>Paramètres</title>
16 <variablelist> 28 <variablelist>
17 <varlistentry> 29 <varlistentry>
18 <term>x </term> 30 <term>lst</term>
19 <listitem> 31 <listitem>
20 <para>une tlist, une mlist ou une struct.</para> 32 <para>Une variable de type tlist, mlist ou struct.</para>
21 </listitem> 33 </listitem>
22 </varlistentry> 34 </varlistentry>
23 <varlistentry> 35 <varlistentry>
24 <term>f</term> 36 <term>f</term>
25 <listitem> 37 <listitem>
26 <para>Un vecteur colonne de chaînes de caractères</para> 38 <para>Un vecteur colonne de chaînes de caractères représentant les noms des champs.</para>
27 </listitem> 39 </listitem>
28 </varlistentry> 40 </varlistentry>
29 </variablelist> 41 </variablelist>
@@ -31,23 +43,27 @@
31 <refsection> 43 <refsection>
32 <title>Description</title> 44 <title>Description</title>
33 <para> 45 <para>
34 returne les noms de champs d'une tlist, d'une mlist ou d'une struct.</para> 46 La fonction <literal>fieldnames</literal> retourne le nom des
47 champs d'une tlist, mlist ou struct. Dans Scilab 5.2,
48 <literal>fieldnames</literal> ne fonctionne pas sur le type
49 cell.
50 </para>
35 </refsection> 51 </refsection>
36 <refsection> 52 <refsection>
37 <title>Exemples</title> 53 <title>Exemples</title>
38 <programlisting role="example"><![CDATA[ 54 <programlisting role="example">
39clear t; 55fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
40t.a=1; 56fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
41t.b=2; 57fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
42fieldnames(t) 58obj.x = 3;
43fieldnames(1/%s) 59obj.y = 3;
44fieldnames(tf2ss(1/%s)) 60fieldnames(obj)
45 ]]></programlisting> 61 </programlisting>
46 </refsection> 62 </refsection>
47 <refsection> 63 <refsection>
48 <title>Voir Aussi</title> 64 <title>Voir Aussi</title>
49 <simplelist type="inline"> 65 <simplelist type="inline">
50 <member> 66 <member>
51 <link linkend="extraction">extraction</link> 67 <link linkend="extraction">extraction</link>
52 </member> 68 </member>
53 <member> 69 <member>