Disable the warning about examples missing. They are internal functions and should...
[scilab.git] / scilab / modules / dynamic_link / help / en_US / ilib_gen_cleaner.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) DIGITEO - 2009 - Allan CORNET
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 xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" scilab:needs-examples="no" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="ilib_gen_cleaner">
14     <refnamediv>
15         <refname>ilib_gen_cleaner</refname>
16         <refpurpose>utility for ilib_build: generates a cleaner file</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>ilib_gen_cleaner(makename,[loadername],[files])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>makename</term>
27                 <listitem>
28                     <para>
29                         character string. The pathname of the Makefile file without extension (default value <literal>''</literal>).
30                     </para>
31                     <para>This parameter is useless since Scilab 5.0.</para>
32                     <para>A warning will be displayed in Scilab 5.3 if you use another value that the default.</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>loadername</term>
37                 <listitem>
38                     <para>
39                         character string. The pathname of the loader file (default value is <literal>loader.sce</literal>).
40                     </para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>files</term>
45                 <listitem>
46                     <para>matrix of character string. files to delete.</para>
47                 </listitem>
48             </varlistentry>
49         </variablelist>
50     </refsection>
51     <refsection>
52         <title>Description</title>
53         <para>
54             This is internal function used by <literal>ilib_build and ilib_for_link</literal>
55             This function generates a cleaner file.
56         </para>
57         <para>
58             <warning>This function should not be used directly.</warning>
59         </para>
60         <para>
61             <emphasis role="bold">Only use this function is you know what you are doing (it is a semi-private function).</emphasis>
62         </para>
63     </refsection>
64     <refsection role="see also">
65         <title>See Also</title>
66         <simplelist type="inline">
67             <member>
68                 <link linkend="ilib_gen_loader">ilib_gen_loader</link>
69             </member>
70             <member>
71                 <link linkend="ilib_build">ilib_build</link>
72             </member>
73             <member>
74                 <link linkend="ilib_for_link">ilib_for_link</link>
75             </member>
76             <member>
77                 <link linkend="api_scilab">api_scilab</link>
78             </member>
79         </simplelist>
80     </refsection>
81 </refentry>