jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

scilab: little fixes in doc

Browse source
This commit is contained in:
Simon Marchetto 2014-03-20 16:32:07 +01:00
commit 4cca1f67cb
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/Manual/Scilab.html
View file

@ -167,8 +167,7 @@ The <tt>swig</tt> command line program has several other options you can use. Se
<H3><a name="Scilab_running_swig_building_module"></a>37.2.2 Building the module</H3> <H3><a name="Scilab_running_swig_building_module"></a>37.2.2 Building the module</H3>
<p> <p>
Scilab external modules are shared libraries (with the <tt>.so</tt> file extension). In Scilab, the generated builder script <tt>builder.sce</tt> is used to build the generated module:
Building such a file is usually done by running the <tt>builder.sce</tt> script in Scilab:
</p> </p>
<div class="shell"><pre> <div class="shell"><pre>
@ -177,7 +176,7 @@ $ ./scilab-cli
</pre></div> </pre></div>
<p> <p>
This command will produce two important files: The build will produce two files:
</p> </p>
<ul> <ul>
@ -315,7 +314,7 @@ SWIG for Scilab provides only low-level C interface for Scilab. This means that
<p> <p>
In Scilab 5.x, identifier names can be composed of 24 chars maximum (this limitation disappears in future version of Scilab 6.0). In Scilab 5.x, identifier names can be composed of 24 chars maximum (this limitation disappears in future version of Scilab 6.0).
<br>So long function or variables names can be truncated. It can be cause of conflict. <br>So long function or variable names may be truncated, which can be cause of conflict.
</p> </p>
<p>It happens especially when wrapping structs/classes, for which the wrapping functions name are composed of the struct/class name and field names. In that case, the SWIG <tt>rename</tt> instruction, to choose a different wrapping name, can be useful. <p>It happens especially when wrapping structs/classes, for which the wrapping functions name are composed of the struct/class name and field names. In that case, the SWIG <tt>rename</tt> instruction, to choose a different wrapping name, can be useful.
<p> <p>
@ -324,7 +323,7 @@ In Scilab 5.x, identifier names can be composed of 24 chars maximum (this limita
<p> <p>
Global functions are wrapped as new Scilab built-in functions. For example: Functions are wrapped as new Scilab built-in functions. For example:
</p> </p>
<div class="code"><pre> <div class="code"><pre>
@ -333,12 +332,15 @@ int fact(int n);
</pre></div> </pre></div>
<p> <p>
Creates a built-in function <tt>fact(n)</tt> that works exactly like you think it does: Creates a built-in function <tt>fact(n)</tt> in Scilab:
</p> </p>
<div class="targetlang"><pre> <div class="targetlang"><pre>
--&gt; fact(4) --&gt; fact(4)
ans=24 ans =
24.
</pre></div> </pre></div>
@ -1340,7 +1342,7 @@ clear get_file_path;
<li><tt><b>fcts</b></tt>: vector of character strings. The name of new Scilab function implemented in the new interface.</li> <li><tt><b>fcts</b></tt>: vector of character strings. The name of new Scilab function implemented in the new interface.</li>
</ul> </ul>
<H3><a name="Scilab_module_initialization"></a>37.</tt> 5.6 Initialization</H3> <H3><a name="Scilab_module_initialization"></a>37.5.6 Initialization</H3>
<p> <p>
A built-in Scilab function is generated for the wrapped module. A built-in Scilab function is generated for the wrapped module.