gschur() was declared obsolete in Scilab 4, now removed
[scilab.git] / scilab / modules / functions / help / ja_JP / head_comments.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr>
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17
18 <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="ja" xml:id="head_comments">
19     
20     <refnamediv>
21         
22         <refname>head_comments</refname>
23         
24         <refpurpose>Scilab関数のヘッダのコメントを表示</refpurpose>
25         
26     </refnamediv>
27     
28     <refsynopsisdiv>
29         
30         <title>呼び出し手順</title>
31         
32         <synopsis>
33             
34             head_comments(name)
35             
36             head_comments(name,%paths)
37             
38         </synopsis>
39         
40     </refsynopsisdiv>
41     
42     <refsection>
43         
44         <title>引数</title>
45         
46         <variablelist>
47             
48             <varlistentry>
49                 
50                 <term>name</term>
51                 
52                 <listitem>
53                     
54                     <para>文字列, 関数名</para>
55                     
56                 </listitem>
57                 
58             </varlistentry>
59             
60             <varlistentry>
61                 
62                 <term>%paths</term>
63                 
64                 <listitem>
65                     
66                     <para>文字列ベクトル, sci-ファイルを探す場所のパス
67                         
68                     </para>
69                     
70                 </listitem>
71                 
72             </varlistentry>
73             
74         </variablelist>
75         
76     </refsection>
77     
78     <refsection>
79         
80         <title>説明</title>
81         
82         <para>
83             
84             <code>head_comments(name)</code> は,
85             
86             (Matlabヘルプのように)
87             
88             関数ヘッダのコメントを表示します.
89             
90             コメントは関連する sci-ファイルから読み込まれます.
91             
92             <varname>name</varname>がライブラリ中の関数の場合,
93             
94             sci-ファイルはライブラリパスで指定したパスとなります
95             
96             (<link linkend="lib">lib</link>参照).
97             
98             <varname>name</varname>がライブラリ中ではない関数の場合,
99             
100             変数<varname>%paths</varname>で指定したディレクトリの中で
101             
102             <varname>name</varname><literal>.sci</literal>という名前のファイルが
103             
104             探されます.
105             
106         </para>
107         
108         <warning>
109             
110             警告: Scilabのほとんどの定義済みの関数はもはやヘッダコメントを
111             
112             有していません.
113             
114         </warning>
115         
116     </refsection>
117     
118     <refsection>
119         
120         <title>例</title>
121         
122         <programlisting role="example"><![CDATA[
123 head_comments sinc
124  ]]></programlisting>
125         
126     </refsection>
127     
128     <refsection role="see also">
129         
130         <title>参照</title>
131         
132         <simplelist type="inline">
133             
134             <member>
135                 
136                 <link linkend="help">help</link>
137                 
138             </member>
139             
140             <member>
141                 
142                 <link linkend="lib">lib</link>
143                 
144             </member>
145             
146         </simplelist>
147         
148     </refsection>
149     
150 </refentry>
151