← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/functions/help/en_US/clearfun.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/functions/help/en_US/clearfun.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<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" version="5.0-subset Scilab" xml:lang="en" xml:id="clearfun">
3
 
  <refnamediv>
4
 
    <refname>clearfun</refname>
5
 
    <refpurpose>removes primitive  </refpurpose>
6
 
  </refnamediv>
7
 
  <refsynopsisdiv>
8
 
    <title>Calling Sequence</title>
9
 
    <synopsis>ret=clearfun('name')</synopsis>
10
 
  </refsynopsisdiv>
11
 
  <refsection>
12
 
    <title>Arguments</title>
13
 
    <variablelist>
14
 
      <varlistentry>
15
 
        <term>'name'</term>
16
 
        <listitem>
17
 
          <para>name of primitive</para>
18
 
        </listitem>
19
 
      </varlistentry>
20
 
      <varlistentry>
21
 
        <term>ret</term>
22
 
        <listitem>
23
 
          <para>a boolean</para>
24
 
        </listitem>
25
 
      </varlistentry>
26
 
    </variablelist>
27
 
  </refsection>
28
 
  <refsection>
29
 
    <title>Arguments</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>'name'</term>
33
 
        <listitem>
34
 
          <para>name of primitive</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>ret</term>
39
 
        <listitem>
40
 
          <para>a boolean</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
    </variablelist>
44
 
  </refsection>
45
 
  <refsection>
46
 
    <title>Description</title>
47
 
    <para>
48
 
      <literal>clearfun('name')</literal> removes the primitive <literal>'name'</literal> from the 
49
 
      set of primitives (built-in functions). <literal>clearfun</literal> returns 
50
 
      <literal>%t</literal> or <literal>%f</literal>.
51
 
      This function allows to rename a primitive : a Scilab primitive can be replaced by a 
52
 
      user-defined function. For experts...
53
 
    </para>
54
 
  </refsection>
55
 
  <refsection role="see also">
56
 
    <title>See Also</title>
57
 
    <simplelist type="inline">
58
 
      <member>
59
 
        <link linkend="newfun">newfun</link>
60
 
      </member>
61
 
      <member>
62
 
        <link linkend="funptr">funptr</link>
63
 
      </member>
64
 
    </simplelist>
65
 
  </refsection>
66
 
</refentry>