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

Change-Id: Ic5406995d6bee97fed69709058064772e52196c2

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

index a6da12f..4da5fb4 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="remove_profiling" xml:lang="fr">
     <refnamediv>
         <refname>remove_profiling</refname>
-        <refpurpose>Removes profiling instructions toout of a function.</refpurpose>
+        <refpurpose>Disables 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 profiled function</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -32,8 +32,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>remove_profiling(funname)</literal> Removes profiling instructions (if any) out of the function
-            named <literal>funname</literal>. 
+            <literal>remove_profiling</literal> removes the instructions needed for the profiling of a function.
         </para>
     </refsection>
     <refsection>
index 5a49b67..9528b61 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="remove_profiling" xml:lang="en">
     <refnamediv>
         <refname>remove_profiling</refname>
-        <refpurpose>Supprime les instructions de "profiling" du code d'une fonction </refpurpose>
+        <refpurpose>Désactive 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 profilée.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -32,9 +32,8 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>remove_profiling(funname)</literal> supprime les
-            instructions de "profiling" du code de la fonction dont le nom est
-            donné par <literal>funname</literal>.
+            <literal>remove_profiling</literal> supprime les
+            instructions nécessaires au profiling d'une fonction.
         </para>
     </refsection>
     <refsection>