* Bug #7190 fixed - is_absolute_path was non documented. 94/10394/2
Charlotte HECQUET [Mon, 4 Feb 2013 12:55:24 +0000 (13:55 +0100)]
Change-Id: Id8a9e2c172a22b11301753b72fabcab1689821f4

scilab/CHANGES_5.4.X
scilab/modules/fileio/help/en_US/path_filename/is_absolute_path.xml [new file with mode: 0644]

index d3df471..dc15840 100644 (file)
@@ -170,6 +170,8 @@ Bug fixes
 
 * Bug #6583 fixed - jmat() was poorly documented.
 
+* Bug #7190 fixed - is_absolute_path was not documented.
+
 * Bug #7583 fixed - binomial function moved in the distribution function
                     chapter.
 
diff --git a/scilab/modules/fileio/help/en_US/path_filename/is_absolute_path.xml b/scilab/modules/fileio/help/en_US/path_filename/is_absolute_path.xml
new file mode 100644 (file)
index 0000000..36caee8
--- /dev/null
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2013 - Scilab Enterprises - Charlotte HECQUET
+ * ...
+ * 
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at    
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ -->
+<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="is_absolute_path">
+    <refnamediv>
+        <refname>is_absolute_path</refname>
+        <refpurpose>checks if argument is an absolute path</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>r = is_absolute_path(path)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>path</term>
+                <listitem>
+                    <para>a character string or a matrix of strings: a directory pathname.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>
+                        a boolean: <constant>%t</constant> if <varname>path</varname> is an absolute path.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <code>r = is_absolute_path(path)</code> checks if <varname>path</varname> is an absolute path.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
+is_absolute_path(TMPDIR)
+is_absolute_path("./scilab/modules/fileio")
+ ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="get_absolute_file_path">get_absolute_file_path</link>
+            </member>
+            <member>
+                <link linkend="fileparts">fileparts</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>