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

Update ocaml documentation (#885)

Browse source 
Update ocaml simple example documentation

Replaced python references by ocaml ones.
This commit is contained in:
Guerin 2017-01-31 22:46:17 +01:00 • committed by Olly Betts
commit 77a9907dd9
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Examples/ocaml/simple/index.html
View file

@ -1,18 +1,18 @@
<html> <html>
<head> <head>
<title>SWIG:Examples:python:simple</title> <title>SWIG:Examples:ocaml:simple</title>
</head> </head>
<body bgcolor="#ffffff"> <body bgcolor="#ffffff">
<tt>SWIG/Examples/python/simple/</tt> <tt>SWIG/Examples/ocaml/simple/</tt>
<hr> <hr>
<H2>Simple Python Example</H2> <H2>Simple Ocaml Example</H2>
<p> <p>
This example illustrates how you can hook Python to a very simple C program containing This example illustrates how you can hook Ocaml to a very simple C program containing
a function and a global variable. a function and a global variable.
<h2>The C Code</h2> <h2>The C Code</h2>
@ -57,7 +57,7 @@ extern double Foo;
<h2>Compilation</h2> <h2>Compilation</h2>
<ol> <ol>
<li><tt>swig -python <a href="example.i">example.i</a></tt> <li><tt>swig -ocaml <a href="example.i">example.i</a></tt>
<p> <p>
<li>Compile <tt><a href="example_wrap.c">example_wrap.c</a></tt> and <tt><a href="example.c">example.c</a></tt> <li>Compile <tt><a href="example_wrap.c">example_wrap.c</a></tt> and <tt><a href="example.c">example.c</a></tt>
to create the extension <tt>examplemodule.so</tt>. to create the extension <tt>examplemodule.so</tt>.
@ -65,29 +65,29 @@ to create the extension <tt>examplemodule.so</tt>.
<h2>Using the extension</h2> <h2>Using the extension</h2>
Click <a href="example.py">here</a> to see a script that calls our C functions from Python. Click <a href="example.ml">here</a> to see a script that calls our C functions from Ocaml.
<h2>Key points</h2> <h2>Key points</h2>
<ul> <ul>
<li>Use the <tt>import</tt> statement to load your extension module from Python. For example: <li>Use the <tt>open</tt> statement to load your extension module from Ocaml. For example:
<blockquote> <blockquote>
<pre> <pre>
import example open Example
</pre> </pre>
</blockquote> </blockquote>
<li>C functions work just like Python functions. For example: <li>C functions work just like Ocaml functions. For example:
<blockquote> <blockquote>
<pre> <pre>
g = example.gcd(42,105) let g = _gcd '(x,y) as int
</pre> </pre>
</blockquote> </blockquote>
<li>C global variables are accessed through a special variable called 'cvar'. For example: <li>C global variable Foo is wrapped as _Foo in ocaml. For example:
<blockquote> <blockquote>
<pre> <pre>
a = example.cvar.Foo let _ = Printf.printf "Foo = %f\n" (_Foo '() as float)
</pre> </pre>
</blockquote> </blockquote>
</ul> </ul>