X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=filetree.mli;h=9730fef49dede99aabe09db8ffbc2dc65a48cd4a;hb=3b2348f5f4b770e3e7f886d851eeadc59bbd2357;hp=46fd39a9d20f132b6964ccbeb8059b2d690fc735;hpb=b9e8c84588873568b7fdfaeb9beb85466e84c8fa;p=guestfs-browser.git

diff --git a/filetree.mli b/filetree.mli
index 46fd39a..9730fef 100644
--- a/filetree.mli
+++ b/filetree.mli
@@ -27,15 +27,21 @@
     http://mail.gnome.org/archives/gtk-app-devel-list/2003-May/msg00241.html *)
 
 type t
+  (** A filetree widget.  Actually an opaque object which contains the
+      widget and other data.  Use the accessors below. *)
 
 val create : packing:(GObj.widget -> unit) -> unit -> t
-  (** Create a new filetree widget (empty). *)
+  (** Create a new filetree widget (empty).
+
+      [~packing] is the required packing for the widget. *)
 
 val clear : t -> unit
   (** Clear out all rows in existing widget. *)
 
-val add : t -> string -> Slave.inspection_data -> unit
+val add : t -> string -> Slave_types.inspection_data -> unit
   (** [add t name data] clears out the widget and adds the operating
-      system and/or filesystems described by the [data] struct.  The
-      [name] parameter should be some host-side (verifiable) name;
-      usually we pass the name of the guest from libvirt here. *)
+      system and/or filesystems described by the [data] struct.
+
+      The [name] parameter should be some host-side (verifiable) name,
+      not any untrusted string from the guest; usually we pass the
+      name of the guest from libvirt here. *)