diff options
Diffstat (limited to 'help/en_US/scilab2c.xml')
-rw-r--r-- | help/en_US/scilab2c.xml | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/help/en_US/scilab2c.xml b/help/en_US/scilab2c.xml new file mode 100644 index 00000000..c726406e --- /dev/null +++ b/help/en_US/scilab2c.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab + * Copyright (C) DIGITEO - Bruno JOFRET + * + * This file is released into the public domain + * + --> +<refentry version="5.0-subset Scilab" xml:id="scilab2c" xml:lang="en" + 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"> + <info> + <pubdate>$LastChangedDate$</pubdate> + </info> + + <refnamediv> + <refname>scilab2c</refname> + + <refpurpose>Scilab to C Converter</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + + <synopsis> + scilab2c(); + scilab2c(inputScript, outputPath); + scilab2c(inputScript, outputPath, pathToADditionnalFunctions); + scilab2c(inputScript, outputPath, pathToADditionnalFunctions, RunMode); + </synopsis> + </refsynopsisdiv> + + <refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>inputScript</term> + <listitem> + <para>This file should contain the scilab function we want + to translate.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>outputPath</term> + <listitem> + <para>Output Path for code genrated and logs.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>pathToADditionnalFunctions</term> + <listitem> + <para>This is the path to look in for additional user defined functions.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>RunMode</term> + <listitem> + <para>Must be "All", "Translate" or "GenLibraryStructure"</para> + </listitem> + </varlistentry> + + </variablelist> + + </refsection> + + <refsection> + <title>Description</title> + + <para>Convert a scilab function into a C File.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example"> + // Launch the GUI + scilab2c(); + + // Convert the function present in myScript.sci + // into a C file : myMain.c + scilab2c("./mysScript.sci", "./"); + + // Example in unit_tests + global SCI2CHOME + scilab2c(SCI2CHOME+"/tests/unit_tests/test000_TrigonIdentity/scilabcode/mainfunction.sci", TMPDIR); + </programlisting> + </refsection> + + <refsection> + <title>See Also</title> + <simplelist type="inline"> + <member> + <link linkend="scilab2c_annotations">Sciab2C Annotations</link> + </member> + </simplelist> + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Bruno JOFRET</member> + <member>Raffaele NUTRICATO</member> + </simplelist> + </refsection> +</refentry> |