From: Richard W.M. Jones <rjones@redhat.com>
Date: Mon, 4 Oct 2010 19:33:14 +0000 (+0100)
Subject: ocaml: Document g#close () method for objects.
X-Git-Tag: 1.5.22~17
X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=commitdiff_plain;h=63bfcdbdd81b81e6a8e2157de36f9e1638801570;ds=sidebyside

ocaml: Document g#close () method for objects.
---

diff --git a/generator/generator_ocaml.ml b/generator/generator_ocaml.ml
index 483d65a..3bdba68 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