summaryrefslogtreecommitdiffstats
path: root/scilab/modules/api_scilab
diff options
context:
space:
mode:
authorantoine ELIAS <antoine.elias@scilab.org>2010-01-22 17:30:34 +0100
committerantoine ELIAS <antoine.elias@scilab.org>2010-01-22 17:30:34 +0100
commit2471f3a0ddb3b57c9572452430584534850fba60 (patch)
treea410b544b20a46c99ea0d4a460649a6e09208ace /scilab/modules/api_scilab
parentda2e3f0ae30e5569a5cc6865127c3ecb637e5e9b (diff)
parent83e197f7eeac818fe0d0b054751b1c35a8e4c60a (diff)
downloadscilab-2471f3a0ddb3b57c9572452430584534850fba60.zip
scilab-2471f3a0ddb3b57c9572452430584534850fba60.tar.gz
Merge branch 'master' of git.scilab.org:scilab
Diffstat (limited to 'scilab/modules/api_scilab')
-rw-r--r--scilab/modules/api_scilab/help/en_US/api_scilab.xml89
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckColumn.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckDimProp.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckDims.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckLength.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckLhs.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckRhs.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckRow.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckSameDims.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckScalar.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckSquare.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/CheckVector.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/FindOpt.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/FirstOpt.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/IsOpt.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/Lhs.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/LhsVar.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/NumOpt.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/OverLoad.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/Rhs.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/get_optionals.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/capi/sci_types.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_boolean_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_bsparse_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_double_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_integer_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_pointer_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_poly_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_sparse_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/help/en_US/list_management/list_string_reading_api.xml2
-rw-r--r--scilab/modules/api_scilab/tests/unit_tests/common_read_api.c2
31 files changed, 140 insertions, 9 deletions
diff --git a/scilab/modules/api_scilab/help/en_US/api_scilab.xml b/scilab/modules/api_scilab/help/en_US/api_scilab.xml
new file mode 100644
index 0000000..57a85d9
--- /dev/null
+++ b/scilab/modules/api_scilab/help/en_US/api_scilab.xml
@@ -0,0 +1,89 @@
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2010 - DIGITEO - Sylvestre LEDRU
5 *
6 * 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 * you should have received as part of this distribution. The terms
9 * are also available at
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 *
12 -->
13<refentry version="5.0-subset Scilab" xml:id="api_scilab" xml:lang="en"
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns5="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info>
21 <pubdate>$LastChangedDate$</pubdate>
22 </info>
23
24 <refnamediv>
25 <refname>api_scilab</refname>
26
27 <refpurpose>api_scilab is the Scilab interface to read/write data from/to Scilab memory </refpurpose>
28 </refnamediv>
29
30 <refsection>
31 <title>Description</title>
32
33 <para>In the previous versions of Scilab, there was no clear or easy way to extend Scilab or to use it as an embedded application.</para>
34<para>Since Scilab 5.2.0, these issues have been tackled by API Scilab. Its provides a new consistent, documented and easy way API.
35</para>
36
37 <para>This API provides functions to read/write data from/to Scilab memory.</para>
38<para> It provides many advantages:</para>
39 <itemizedlist>
40 <listitem>
41<para>Management of all Scilab data types</para></listitem>
42<listitem>
43<para>Consistency over all data types</para></listitem>
44<listitem>
45<para>Error management</para></listitem>
46<listitem>
47<para>Fully documented</para></listitem>
48<listitem>
49<para>Fully tested by unitary tests</para></listitem>
50<listitem>
51<para>Straight and named access (See the <link linkend="call_scilab">call_scilab API</link>) to variables.</para></listitem>
52<listitem>
53<para>And it will be maintained over future versions of Scilab</para></listitem>
54</itemizedlist>
55
56<para>Usually, this API is used to extend Scilab capabilities but can be used in other contexts</para>
57
58 <itemizedlist>
59 <listitem>
60<para>Libraires or C/C++ functions: Many librairies have been developped on the free/Open source or proprietary markets. This library can be loaded and used in a high level language like Scilab. API Scilab provides the capabilities to interact with such libraries.
61</para>
62 </listitem>
63 <listitem>
64<para>Scilab can be used as computing engine from a third party software. This feature is called <link linkend="call_scilab">call_scilab</link> when Scilab is used from C/C++ code or <link linkend="javasci">javasci</link> when used from Java. Access to variable is done through their names (named variable).
65</para>
66 </listitem>
67</itemizedlist>
68 <para>Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).</para>
69 </refsection>
70
71 <refsection>
72 <title>See Also</title>
73
74 <simplelist type="inline">
75 <member><link linkend="compile_and_run_call_scilab">Compile and run with
76 call_scilab</link>, <link linkend="DoubleManagement_callscilab">Matrix
77 Management</link>, <link linkend="BooleanManagement_callscilab">Boolean
78 Management</link>, <link linkend="ComplexManagement_callscilab">Complex
79 Management</link>, <link linkend="StringManagement_callscilab">String
80 Management</link>, <link linkend="call_scilab">Call_Scilab</link></member>
81 </simplelist>
82 </refsection>
83
84 <refsection>
85 <title>Authors</title>
86
87 <para>Sylvestre Ledru</para>
88 </refsection>
89</refentry>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckColumn.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckColumn.xml
index 8cae396..385ca22 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckColumn.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckColumn.xml
@@ -58,6 +58,8 @@
58 <para>C interface function which checks if a parameter send to the C 58 <para>C interface function which checks if a parameter send to the C
59 function is a column vector or not. You must include stack-c.h to benefit 59 function is a column vector or not. You must include stack-c.h to benefit
60 from this function.</para> 60 from this function.</para>
61
62 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
61 </refsection> 63 </refsection>
62 64
63 <refsection> 65 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckDimProp.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckDimProp.xml
index 47a3e43..7aa56e6 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckDimProp.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckDimProp.xml
@@ -59,6 +59,8 @@
59 arguments send to the C function. You must include stack-c.h to benefit 59 arguments send to the C function. You must include stack-c.h to benefit
60 from this function. If the test fails, we return from the C interface and 60 from this function. If the test fails, we return from the C interface and
61 an adequate error message is printed in the Scilab console.</para> 61 an adequate error message is printed in the Scilab console.</para>
62
63 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
62 </refsection> 64 </refsection>
63 65
64 <refsection> 66 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckDims.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckDims.xml
index 8afe7f2..2c755e3 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckDims.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckDims.xml
@@ -76,6 +76,8 @@
76 benefit from this function. If the test fails, we return from the C 76 benefit from this function. If the test fails, we return from the C
77 interface and an adequate error message is printed in the Scilab 77 interface and an adequate error message is printed in the Scilab
78 console.</para> 78 console.</para>
79
80 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
79 </refsection> 81 </refsection>
80 82
81 <refsection> 83 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckLength.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckLength.xml
index 7338031..0dabe29 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckLength.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckLength.xml
@@ -58,6 +58,8 @@
58 parameter to the C function. You must include stack-c.h to benefit from 58 parameter to the C function. You must include stack-c.h to benefit from
59 this function. If the test fails, we return from the C interface and an 59 this function. If the test fails, we return from the C interface and an
60 adequate error message is printed in the Scilab console.</para> 60 adequate error message is printed in the Scilab console.</para>
61
62 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
61 </refsection> 63 </refsection>
62 64
63 <refsection> 65 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckLhs.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckLhs.xml
index eff39b4..ef8b816 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckLhs.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckLhs.xml
@@ -56,6 +56,8 @@
56 0;</literal> within the gateway function, it is important to call this 56 0;</literal> within the gateway function, it is important to call this
57 macro before any memory allocation in order to avoid any memory 57 macro before any memory allocation in order to avoid any memory
58 leak.</para> 58 leak.</para>
59
60 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
59 </refsection> 61 </refsection>
60 62
61 <refsection> 63 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckRhs.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckRhs.xml
index a4f43c6..9e7ca14 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckRhs.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckRhs.xml
@@ -58,6 +58,8 @@
58 0;</literal> within the gateway function, it is important to call this 58 0;</literal> within the gateway function, it is important to call this
59 macro before any memory allocation in order to avoid any memory 59 macro before any memory allocation in order to avoid any memory
60 leak.</para> 60 leak.</para>
61
62 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
61 </refsection> 63 </refsection>
62 64
63 <refsection> 65 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckRow.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckRow.xml
index 47204ca..1011a22 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckRow.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckRow.xml
@@ -59,6 +59,8 @@
59 function is a row vector or not. You must include stack-c.h to benefit 59 function is a row vector or not. You must include stack-c.h to benefit
60 from this function. If the test fails, we return from the C interface and 60 from this function. If the test fails, we return from the C interface and
61 an adequate error message is printed in the Scilab console.</para> 61 an adequate error message is printed in the Scilab console.</para>
62
63 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
62 </refsection> 64 </refsection>
63 65
64 <refsection> 66 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckSameDims.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckSameDims.xml
index 7299ec7..b63d8a4 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckSameDims.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckSameDims.xml
@@ -86,6 +86,8 @@
86 function have the same size. You must include stack-c.h to benefit from 86 function have the same size. You must include stack-c.h to benefit from
87 this function. If the test fails, we return from the C interface and an 87 this function. If the test fails, we return from the C interface and an
88 adequate error message is printed in the Scilab console.</para> 88 adequate error message is printed in the Scilab console.</para>
89
90 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
89 </refsection> 91 </refsection>
90 92
91 <refsection> 93 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckScalar.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckScalar.xml
index e293262..43056df 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckScalar.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckScalar.xml
@@ -58,6 +58,8 @@
58 <para>C interface function which checks if a parameter send to the C 58 <para>C interface function which checks if a parameter send to the C
59 function is a scalar or not. You must include stack-c.h to benefit from 59 function is a scalar or not. You must include stack-c.h to benefit from
60 this function.</para> 60 this function.</para>
61
62 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
61 </refsection> 63 </refsection>
62 64
63 <refsection> 65 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckSquare.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckSquare.xml
index 298dbb9..d37dc09 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckSquare.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckSquare.xml
@@ -59,6 +59,8 @@
59 function is a square matrix or not. You must include stack-c.h to benefit 59 function is a square matrix or not. You must include stack-c.h to benefit
60 from this function. If the test fails, we return from the C interface and 60 from this function. If the test fails, we return from the C interface and
61 an adequate error message is printed in the Scilab console.</para> 61 an adequate error message is printed in the Scilab console.</para>
62
63 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
62 </refsection> 64 </refsection>
63 65
64 <refsection> 66 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/CheckVector.xml b/scilab/modules/api_scilab/help/en_US/capi/CheckVector.xml
index d016858..78418be 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/CheckVector.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/CheckVector.xml
@@ -60,6 +60,8 @@
60 benefit from this function. If the test fails, we return from the C 60 benefit from this function. If the test fails, we return from the C
61 interface and an adequate error message is printed in the Scilab 61 interface and an adequate error message is printed in the Scilab
62 console.</para> 62 console.</para>
63
64 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
63 </refsection> 65 </refsection>
64 66
65 <refsection> 67 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/FindOpt.xml b/scilab/modules/api_scilab/help/en_US/capi/FindOpt.xml
index f92a84e..585f977 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/FindOpt.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/FindOpt.xml
@@ -66,6 +66,8 @@ typedef struct rhs_opts__ {
66 <para>A C gateway function which find the position of an optional argument 66 <para>A C gateway function which find the position of an optional argument
67 given its name. You must include stack-c.h to benefit from this 67 given its name. You must include stack-c.h to benefit from this
68 function.</para> 68 function.</para>
69
70 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
69 </refsection> 71 </refsection>
70 72
71 <refsection> 73 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/FirstOpt.xml b/scilab/modules/api_scilab/help/en_US/capi/FirstOpt.xml
index 0366a36..d064461 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/FirstOpt.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/FirstOpt.xml
@@ -40,6 +40,8 @@
40 <para>A C gateway function which returns the position of the first 40 <para>A C gateway function which returns the position of the first
41 optional parameter. You must include stack-c.h to benefit from this 41 optional parameter. You must include stack-c.h to benefit from this
42 function.</para> 42 function.</para>
43
44 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
43 </refsection> 45 </refsection>
44 46
45 <refsection> 47 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/IsOpt.xml b/scilab/modules/api_scilab/help/en_US/capi/IsOpt.xml
index e081264..cbe2cea 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/IsOpt.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/IsOpt.xml
@@ -58,6 +58,8 @@
58 <para>C gateway function which checks if a parameter is optional and 58 <para>C gateway function which checks if a parameter is optional and
59 returns the name of the parameter. You must include stack-c.h to benefit 59 returns the name of the parameter. You must include stack-c.h to benefit
60 from this function.</para> 60 from this function.</para>
61
62 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
61 </refsection> 63 </refsection>
62 64
63 <refsection> 65 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/Lhs.xml b/scilab/modules/api_scilab/help/en_US/capi/Lhs.xml
index 881f055..d703e43 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/Lhs.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/Lhs.xml
@@ -42,6 +42,8 @@
42 stack-c.h to benefit from this function.</para> 42 stack-c.h to benefit from this function.</para>
43 43
44 <para>Note: Lhs means Left Hand Side.</para> 44 <para>Note: Lhs means Left Hand Side.</para>
45
46 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
45 </refsection> 47 </refsection>
46 48
47 <refsection> 49 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/LhsVar.xml b/scilab/modules/api_scilab/help/en_US/capi/LhsVar.xml
index 6f171ad..1c8294a 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/LhsVar.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/LhsVar.xml
@@ -49,6 +49,8 @@
49 49
50 <para>A C gateway function which specifies which variables created inside 50 <para>A C gateway function which specifies which variables created inside
51 the C interface will be returned as an output argumen into Scilab.</para> 51 the C interface will be returned as an output argumen into Scilab.</para>
52
53 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
52 </refsection> 54 </refsection>
53 55
54 <refsection> 56 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/NumOpt.xml b/scilab/modules/api_scilab/help/en_US/capi/NumOpt.xml
index 364fdaf..ddacf92 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/NumOpt.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/NumOpt.xml
@@ -39,6 +39,8 @@
39 <para>A C gateway function which returns the number of optional parameters 39 <para>A C gateway function which returns the number of optional parameters
40 sent to a C function. You must include stack-c.h to benefit from this 40 sent to a C function. You must include stack-c.h to benefit from this
41 function.</para> 41 function.</para>
42
43 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
42 </refsection> 44 </refsection>
43 45
44 <refsection> 46 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/OverLoad.xml b/scilab/modules/api_scilab/help/en_US/capi/OverLoad.xml
index ab2e916..e85cabe 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/OverLoad.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/OverLoad.xml
@@ -48,6 +48,8 @@
48 overloading process of Scilab works only on Scilab primitives (Scilab 48 overloading process of Scilab works only on Scilab primitives (Scilab
49 function wrote in C) which must have a Scilab name which is maximum 8 char 49 function wrote in C) which must have a Scilab name which is maximum 8 char
50 wide.</para> 50 wide.</para>
51
52 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
51 </refsection> 53 </refsection>
52 54
53 <refsection> 55 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/Rhs.xml b/scilab/modules/api_scilab/help/en_US/capi/Rhs.xml
index 342af42..54bf5b6 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/Rhs.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/Rhs.xml
@@ -42,6 +42,8 @@
42 benefit from this function.</para> 42 benefit from this function.</para>
43 43
44 <para>Note: Rhs means Right Hand Side.</para> 44 <para>Note: Rhs means Right Hand Side.</para>
45
46 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
45 </refsection> 47 </refsection>
46 48
47 <refsection> 49 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/get_optionals.xml b/scilab/modules/api_scilab/help/en_US/capi/get_optionals.xml
index cc7472f..f2b5055 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/get_optionals.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/get_optionals.xml
@@ -67,6 +67,8 @@ typedef struct rhs_opts__ {
67 <para>A C gateway function which initialize the list of optional 67 <para>A C gateway function which initialize the list of optional
68 parameters. You must include stack-c.h to benefit from this 68 parameters. You must include stack-c.h to benefit from this
69 function.</para> 69 function.</para>
70
71 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
70 </refsection> 72 </refsection>
71 73
72 <refsection> 74 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/capi/sci_types.xml b/scilab/modules/api_scilab/help/en_US/capi/sci_types.xml
index ab9f093..1dc0bc0 100644
--- a/scilab/modules/api_scilab/help/en_US/capi/sci_types.xml
+++ b/scilab/modules/api_scilab/help/en_US/capi/sci_types.xml
@@ -99,6 +99,8 @@
99 99
100 <para>If this function is used, it is probable that <link 100 <para>If this function is used, it is probable that <link
101 linkend="GetType">GetType</link> will also be used.</para> 101 linkend="GetType">GetType</link> will also be used.</para>
102
103 <para>WARNING: This API is deprecated from Scilab 5.2.0 and is going to be removed with Scilab 6.0. Please use <link linkend="api_scilab">API Scilab</link> (the new Scilab API).</para>
102 </refsection> 104 </refsection>
103 105
104 <refsection> 106 <refsection>
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_boolean_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_boolean_reading_api.xml
index 92d7cf8..6644a45 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_boolean_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_boolean_reading_api.xml
@@ -208,7 +208,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
208 break; 208 break;
209 default : 209 default :
210 insert_indent(); 210 insert_indent();
211 sciprint("Unknow type\n"); 211 sciprint("Unknown type\n");
212 return 1; 212 return 1;
213 } 213 }
214 return iRet; 214 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_bsparse_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_bsparse_reading_api.xml
index b954fc2..fc2c511 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_bsparse_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_bsparse_reading_api.xml
@@ -224,7 +224,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
224 break; 224 break;
225 default : 225 default :
226 insert_indent(); 226 insert_indent();
227 sciprint("Unknow type\n"); 227 sciprint("Unknown type\n");
228 return 1; 228 return 1;
229 } 229 }
230 return iRet; 230 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_double_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_double_reading_api.xml
index 3dd6e6e..e5255c6 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_double_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_double_reading_api.xml
@@ -218,7 +218,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
218 break; 218 break;
219 default : 219 default :
220 insert_indent(); 220 insert_indent();
221 sciprint("Unknow type\n"); 221 sciprint("Unknown type\n");
222 return 1; 222 return 1;
223 } 223 }
224 return iRet; 224 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_integer_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_integer_reading_api.xml
index 2507619..a9c4a49 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_integer_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_integer_reading_api.xml
@@ -222,7 +222,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
222 break; 222 break;
223 default : 223 default :
224 insert_indent(); 224 insert_indent();
225 sciprint("Unknow type\n"); 225 sciprint("Unknown type\n");
226 return 1; 226 return 1;
227 } 227 }
228 return iRet; 228 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_pointer_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_pointer_reading_api.xml
index 64b4a6e..b8d5a12 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_pointer_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_pointer_reading_api.xml
@@ -200,7 +200,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
200 break; 200 break;
201 default : 201 default :
202 insert_indent(); 202 insert_indent();
203 sciprint("Unknow type\n"); 203 sciprint("Unknown type\n");
204 return 1; 204 return 1;
205 } 205 }
206 return iRet; 206 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_poly_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_poly_reading_api.xml
index baad198..b4643f7 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_poly_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_poly_reading_api.xml
@@ -226,7 +226,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
226 break; 226 break;
227 default : 227 default :
228 insert_indent(); 228 insert_indent();
229 sciprint("Unknow type\n"); 229 sciprint("Unknown type\n");
230 return 1; 230 return 1;
231 } 231 }
232 return iRet; 232 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_sparse_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_sparse_reading_api.xml
index f32f85f..21b759e 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_sparse_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_sparse_reading_api.xml
@@ -242,7 +242,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
242 break; 242 break;
243 default : 243 default :
244 insert_indent(); 244 insert_indent();
245 sciprint("Unknow type\n"); 245 sciprint("Unknown type\n");
246 return 1; 246 return 1;
247 } 247 }
248 return iRet; 248 return iRet;
diff --git a/scilab/modules/api_scilab/help/en_US/list_management/list_string_reading_api.xml b/scilab/modules/api_scilab/help/en_US/list_management/list_string_reading_api.xml
index 4581748..7baaff6 100644
--- a/scilab/modules/api_scilab/help/en_US/list_management/list_string_reading_api.xml
+++ b/scilab/modules/api_scilab/help/en_US/list_management/list_string_reading_api.xml
@@ -216,7 +216,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
216 break; 216 break;
217 default : 217 default :
218 insert_indent(); 218 insert_indent();
219 sciprint("Unknow type\n"); 219 sciprint("Unknown type\n");
220 return 1; 220 return 1;
221 } 221 }
222 return iRet; 222 return iRet;
diff --git a/scilab/modules/api_scilab/tests/unit_tests/common_read_api.c b/scilab/modules/api_scilab/tests/unit_tests/common_read_api.c
index c1bd2c8..cc75274 100644
--- a/scilab/modules/api_scilab/tests/unit_tests/common_read_api.c
+++ b/scilab/modules/api_scilab/tests/unit_tests/common_read_api.c
@@ -113,7 +113,7 @@ int get_info(int _iRhs, int* _piParent, int *_piAddr, int _iItemPos)
113 break; 113 break;
114 default : 114 default :
115 insert_indent(); 115 insert_indent();
116 sciprint("Unknow type\n"); 116 sciprint("Unknown type\n");
117 return 1; 117 return 1;
118 } 118 }
119 return iRet; 119 return iRet;