[gtkmm] Gtk::Clipboard::wait_for_uris(): Fix the documentation



commit 4b020269c3fc8187a666fa67226e8aac8881c035
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Thu Aug 11 18:37:33 2016 +0200

    Gtk::Clipboard::wait_for_uris(): Fix the documentation
    
    The description of the return value was not very good, when it was copied
    from the gtk+ doc, and it got worse when gmmproc started removing
    sentences with "g_strfreev".

 gtk/src/clipboard.hg |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
---
diff --git a/gtk/src/clipboard.hg b/gtk/src/clipboard.hg
index 106c0f4..4931c5a 100644
--- a/gtk/src/clipboard.hg
+++ b/gtk/src/clipboard.hg
@@ -270,6 +270,17 @@ public:
   _IGNORE(gtk_clipboard_wait_for_targets)
 
 #m4 
_CONVERSION(`gchar**',`std::vector<Glib::ustring>',`Glib::ArrayHandler<Glib::ustring>::array_to_vector($3, 
Glib::OWNERSHIP_DEEP)')
+  /** Requests the contents of the clipboard as URIs. This function waits
+   * for the data to be received using the main loop, so events,
+   * timeouts, etc, may be dispatched during the wait.
+   *
+   * @newin{2,14}
+   *
+   * @return A vector of strings, which is empty if retrieving the
+   * selection data failed. (This could happen for various reasons,
+   * in particular if the clipboard was empty or if the contents of
+   * the clipboard could not be converted into URI form.).
+   */
   _WRAP_METHOD(std::vector<Glib::ustring> wait_for_uris() const, gtk_clipboard_wait_for_uris)
 
   /** Hints that the clipboard data should be stored somewhere when the application exits or when store()


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]