Fix documentation for *_run_* methods

20080109174646-53eee-b9b35b5d6c7e7ba2146936fce3456dd18b41ce31.gz

1 files changed, 5 insertions, 2 deletions

diff --git a/tools/glib-client-gen.py b/tools/glib-client-gen.py
index b43cf0be8..0d85033b4 100644
--- a/tools/glib-client-gen.py
+++ b/tools/glib-client-gen.py
@@ -944,8 +944,11 @@ class Generator(object):
 
         self.b(' * @error: Used to return errors if %FALSE is returned')
         self.b(' *')
-        self.b(' * Call the method %s and block, without' % member)
-        self.b(' * re-entering the main loop, until it returns.')
+        self.b(' * Call the method %s and run the main loop' % member)
+        self.b(' * until it returns. Before calling this method, you must')
+        self.b(' * add a reference to any borrowed objects you need to keep,')
+        self.b(' * and generally ensure that everything is in a consistent')
+        self.b(' * state.')
         self.b(' *')
         self.b(' * <![CDATA[%s]]>'
                 % (get_docstring(method) or '(Undocumented)'))