functions: fix add_profiling documentation (simplify, focus on what it does) 16/12716/2
Simon [Fri, 27 Sep 2013 15:27:55 +0000 (17:27 +0200)]
Author:    Simon Marchetto <simon.marchetto@scilab-enterprises.com>

Change-Id: Ib60dadd6ce1e340fbe3c5c47130074f74bdb3c77

scilab/modules/functions/help/en_US/profiling/add_profiling.xml
scilab/modules/functions/help/fr_FR/profiling/add_profiling.xml

index 3b9c1ec..0489fb2 100644 (file)
@@ -12,7 +12,7 @@
 <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" xmlns:scilab="http://www.scilab.org" xml:id="add_profiling" xml:lang="fr">
     <refnamediv>
         <refname>add_profiling</refname>
-        <refpurpose>Adds profiling instructions to a function.</refpurpose>
+        <refpurpose>Enables the profiling of a function</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -24,7 +24,7 @@
             <varlistentry>
                 <term>funname</term>
                 <listitem>
-                    <para>A character string, the name of the function</para>
+                    <para>A character string, the name of the function to be profiled</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>add_profiling(funname)</literal> Adds profiling instructions to the function
-            named <literal>funname</literal>. Then when this function is run the number of calls, the
-            time spent is stored for each function line.
+            <literal>add_profiling</literal> adds the instructions needed for the profiling of a function.
+            Then, when this function is executed, the number of calls and the
+            time spent, for each line, are stored.
+            These data can be returned with the <link linkend="profile">profile</link> function.
         </para>
     </refsection>
     <refsection>
index 59cd0f8..b5271b5 100644 (file)
@@ -12,7 +12,7 @@
 <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" xmlns:scilab="http://www.scilab.org" xml:id="add_profiling" xml:lang="en">
     <refnamediv>
         <refname>add_profiling</refname>
-        <refpurpose>Ajoute les instructions de "profiling" au code d'une fonction </refpurpose>
+        <refpurpose>Active le profiling d'une fonction</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
@@ -24,7 +24,7 @@
             <varlistentry>
                 <term>funname</term>
                 <listitem>
-                    <para>Une chaine de caractères: le nom de la fonction</para>
+                    <para>Une chaine de caractères: le nom de la fonction à profiler</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>add_profiling(funname)</literal> Ajoute les
-            instructions de "profiling" au code de la fonction dont le nom est
-            donné par <literal>funname</literal>. Ensuite lors des appels
-            de la fonction <literal>funname</literal>, le nombre d'appel ainsi
-            que le temps d'execution de chaque ligne est stocké .
+            <literal>add_profiling</literal> ajoute les
+            instructions nécessaires au profiling d'une fonction. Ainsi, lors des appels
+            de cette fonction, le nombre d'appels et le temps d'exécution de chaque ligne sont stockés.
+            Ces données peuvent être ensuite retournées avec la fonction <link linkend="profile">profile</link>.
         </para>
     </refsection>
     <refsection>