summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2010-10-04 20:33:14 +0100
committerRichard W.M. Jones <rjones@redhat.com>2010-10-04 20:33:14 +0100
commit63bfcdbdd81b81e6a8e2157de36f9e1638801570 (patch)
tree25a4488fc9d94adca512c24f71e1f2e588805a22
parent6af1cd7245de0183404ea6aadda4c2f63f9f616b (diff)
downloadlibguestfs-63bfcdbdd81b81e6a8e2157de36f9e1638801570.tar.gz
libguestfs-63bfcdbdd81b81e6a8e2157de36f9e1638801570.tar.xz
libguestfs-63bfcdbdd81b81e6a8e2157de36f9e1638801570.zip
ocaml: Document g#close () method for objects.
-rw-r--r--generator/generator_ocaml.ml3
1 files changed, 3 insertions, 0 deletions
diff --git a/generator/generator_ocaml.ml b/generator/generator_ocaml.ml
index 483d65a2..3bdba68f 100644
--- a/generator/generator_ocaml.ml
+++ b/generator/generator_ocaml.ml
@@ -102,6 +102,9 @@ val clear_progress_callback : t -> unit
it offers exactly the same functionality.
Calling [new guestfs ()] creates both the object and the handle.
+ The object and handle are closed either implicitly when the
+ object is garbage collected, or explicitly by calling the [g#close ()]
+ method.
Note that methods that take no parameters (except the implicit handle)
get an extra unit [()] parameter. This is so you can create a