1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr>
*
* 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 version="5.0-subset Scilab" xml:id="head_comments" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns4="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:db="http://docbook.org/ns/docbook">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>head_comments</refname>
<refpurpose>exibe comentrios do cabealho da funo Scilab</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Seqncia de Chamamento</title>
<synopsis>head_comments(name)
head_comments(name,%paths)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Parmetros</title>
<variablelist>
<varlistentry>
<term>name</term>
<listitem>
<para>string, nome da funo</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%paths</term>
<listitem>
<para>vetor de strings, endereos onde se deve procurar o arquivo
sci</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Descrio</title>
<para><literal>comments(name)</literal> exibe comentrios do cabealho da
funo (como a ajuda do Matlab). Os comentrios so lidos do arquivo sci
associado. Se <literal>name</literal> for uma funo em uma biblioteca, o
endereo do arquivo sci aquele dado pelo endereo da biblioteca (ver
<literal>lib</literal>). Se <literal>name</literal> for uma funo que no
est na biblioteca, um arquivo de nome <literal>name.sci</literal>
procurado nos outros diretrios fornecidos pela varivel
<literal>%paths</literal></para>
<para>AVISO: a maior parte das funes Scilab predefinidas no possui
comentrios de cabealho.</para>
</refsection>
<refsection>
<title>Exemplos</title>
<programlisting role="example"><![CDATA[
head_comments sinc
]]></programlisting>
</refsection>
<refsection>
<title>Ver Tambm</title>
<simplelist type="inline">
<member><link linkend="help">help</link></member>
</simplelist>
</refsection>
<refsection>
<title>Autor</title>
<para>Serge Steer, INRIA</para>
</refsection>
</refentry>
|
