<?xml version="1.0" encoding="UTF-8"?>
<!-- * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 * -->
<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="ilib_include_flag">
    <refnamediv>
        <refname>ilib_include_flag</refname>
        <refpurpose>Return a formatted includes related string to pass to
            system compiler
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Call Sequence</title>
        <synopsis>compiler_flag = ilib_include_flag(path_strings)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>path_strings</term>
                <listitem>
                    <para>Vector of relative or absolute path as string.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>compiler_flag</term>
                <listitem>
                    <para>Compiler flag as string</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>This function is an utility function provided to handle several
            includes path. The result can be passed to tbx_build_gateway.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[

    includes_path = ["../src/includes";"/usr/include/somelib/includes";"."];
    includes_src_c = ilib_include_flag(includes_path);

    ilib_build('somelib',['myfun',sci_myfun'],['myfile.c'],[],[],includes_src_c);

]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="tbx_build_gateway">tbx_build_gateway</link>
                <link linkend="ilib_build">ilib_build</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
