summaryrefslogtreecommitdiffstats
path: root/scilab/modules/api_scilab
diff options
context:
space:
mode:
authorYann Collette <yann.collette@scilab.org>2010-01-18 09:37:25 +0100
committerYann Collette <yann.collette@scilab.org>2010-01-18 09:37:25 +0100
commit3041d066ca3601183c61390305dc9c91cb5a632f (patch)
treed8c0b91149ab8e78ae9fbb64bff34351ad131031 /scilab/modules/api_scilab
parent2c5dcec3e6dfd8d6c6700ad16987d5410e2d94ca (diff)
downloadscilab-3041d066ca3601183c61390305dc9c91cb5a632f.zip
scilab-3041d066ca3601183c61390305dc9c91cb5a632f.tar.gz
mark all the documentation pages in CAPI as deprecated. They will be removed for Scilab 6
Diffstat (limited to 'scilab/modules/api_scilab')
-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
21 files changed, 42 insertions, 0 deletions
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..7434633 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. It will be removed in Scilab 6. Please use the new API instead.</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..fb287c6 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. It will be removed in Scilab 6. Please use the new API instead.</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..7730e1a 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. It will be removed in Scilab 6. Please use the new API instead.</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..c383501 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. It will be removed in Scilab 6. Please use the new API instead.</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..1782c99 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. It will be removed in Scilab 6. Please use the new API instead.</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..1d491cc 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. It will be removed in Scilab 6. Please use the new API instead.</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..fe86169 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. It will be removed in Scilab 6. Please use the new API instead.</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..79098b6 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. It will be removed in Scilab 6. Please use the new API instead.</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..5531614 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. It will be removed in Scilab 6. Please use the new API instead.</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..5f687a8 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. It will be removed in Scilab 6. Please use the new API instead.</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..5ee7aab 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. It will be removed in Scilab 6. Please use the new API instead.</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..356b73f 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. It will be removed in Scilab 6. Please use the new API instead.</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..b96b74b 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. It will be removed in Scilab 6. Please use the new API instead.</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..7001da9 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. It will be removed in Scilab 6. Please use the new API instead.</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..d98b23a 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. It will be removed in Scilab 6. Please use the new API instead.</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..a6fb400 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. It will be removed in Scilab 6. Please use the new API instead.</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..10fbfda 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. It will be removed in Scilab 6. Please use the new API instead.</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..a1d79f3 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. It will be removed in Scilab 6. Please use the new API instead.</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..c054b61 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. It will be removed in Scilab 6. Please use the new API instead.</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..c6fd2f9 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. It will be removed in Scilab 6. Please use the new API instead.</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..fd26c38 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. It will be removed in Scilab 6. Please use the new API instead.</para>
102 </refsection> 104 </refsection>
103 105
104 <refsection> 106 <refsection>