* Bug #7804 fixed - Small improvements in struct help page. 52/14552/3
Charlotte HECQUET [Wed, 21 May 2014 07:24:11 +0000 (09:24 +0200)]
Change-Id: I161c441900c7565ffbb4f49dd763f324a1899a5b

scilab/CHANGES_5.5.X
scilab/modules/data_structures/help/en_US/struct.xml
scilab/modules/data_structures/help/fr_FR/struct.xml

index 510e11d..e771324 100644 (file)
@@ -12,6 +12,8 @@ Scilab Bug Fixes
 
 * Bug #7549 fixed - edit_curv did not disable standard plot menus.
 
+* Bug #7804 fixed - Small improvements made in struct help page.
+
 * Bug #8646 fixed - The datatips contextual menu opened a selection list which
                     was not ergonomic.
 
index 4104ee0..682b9eb 100644 (file)
         <title>Description</title>
         <para>
             This function returns a struct with the fields names
-            <varname>fields1</varname>, <varname>field2</varname>, ..., and the fields values
+            <varname>field1</varname>, <varname>field2</varname>, ..., and the fields values
             corresponding <varname>value1</varname>, <varname>value2</varname>, ...
         </para>
+        <para>
+            Note that <literal>type(st)</literal> returns <literal>17</literal>, and <literal>typeof(st)</literal> returns <literal>st</literal>.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
 //create a struct date
 date_st=struct('day',25,'month' ,'DEC','year',2006)
 //change the month
 date_st.month='AUG';
 //change the year
 date_st.year=1973;
 //change the day
 date_st.day=19;
 //add a new field
 date_st.semaine=32
+
+//create a structure test
+test=struct('list1',list('testlist',1,2), 'matrix1', [1 2 3; 4 5 6], 'boolean1', %t);
+//add a polynom
+s=poly(0,'s')
+test.pol1=s;
+//add a state-space
+A=[0,1;0,0]; B=[1;1];C=[1,1];
+test.ss1=syslin('c',A,B,C);
+//Show the list
+test.list1
+getfield(3,test)
+//Show the type
+type(test)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -71,6 +84,18 @@ date_st.semaine=32
             <member>
                 <link linkend="cell">cell</link>
             </member>
+            <member>
+                <link linkend="mlist">mlist</link>
+            </member>
+            <member>
+                <link linkend="tlist">tlist</link>
+            </member>
+            <member>
+                <link linkend="getfield">getfield</link>
+            </member>
+            <member>
+                <link linkend="setfield">setfield</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 5f0f02d..fedbf16 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            La fonction <literal>struc</literal>t retourne une struct avec des noms de
-            champs <literal>field1</literal>, <literal>field2</literal>, .., et dont les valeurs
-            respectives sont <literal>value</literal><literal>1</literal>, <literal>value2</literal>,
+            La fonction <function>struct</function> retourne une struct avec des noms de
+            champs <varname>field1</varname>, <varname>field2</varname>, .., et dont les valeurs
+            respectives sont <varname>value1</varname>, <varname>value2</varname>,
             ...
         </para>
+        <para>
+            Notez que <literal>type(st)</literal> retourne <literal>17</literal> et que <literal>typeof(st)</literal> retourne <literal>st</literal>.
+        </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
@@ -49,6 +52,20 @@ date_st.annee=1973;
 
 // ajouter un champ 'semaine'
 date_st.semaine=32
+
+//creation d'une structure test
+test=struct('list1',list('testlist',1,2), 'matrix1', [1 2 3; 4 5 6], 'boolean1', %t);
+//ajout d'un polynôme
+s=poly(0,'s')
+test.pol1=s;
+//ajout d'un système linéaire (représentation d'état)
+A=[0,1;0,0]; B=[1;1];C=[1,1];
+test.ss1=syslin('c',A,B,C);
+//Affichage de la liste
+test.list1
+getfield(3,test)
+//Affichage du type
+type(test)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -57,6 +74,18 @@ date_st.semaine=32
             <member>
                 <link linkend="cell">cell</link>
             </member>
+            <member>
+                <link linkend="mlist">mlist</link>
+            </member>
+            <member>
+                <link linkend="tlist">tlist</link>
+            </member>
+            <member>
+                <link linkend="getfield">getfield</link>
+            </member>
+            <member>
+                <link linkend="setfield">setfield</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>