[mutter/wip/nielsdg/cursor-moved-marshal: 14/14] cursor-tracker: Document cursor-moved signal



commit 5b98cc7a3a2329a7ecaa4d9141eadd1ae73e0c9c
Author: Niels De Graef <niels degraef barco com>
Date:   Wed Jul 24 11:34:35 2019 +0200

    cursor-tracker: Document cursor-moved signal
    
    It's a bit easier to track what's going on in a signal if you document
    it (otherwise you have to check where it was emitted in the code).
    
    https://gitlab.gnome.org/GNOME/mutter/merge_requests/697

 src/backends/meta-cursor-tracker.c | 8 ++++++++
 1 file changed, 8 insertions(+)
---
diff --git a/src/backends/meta-cursor-tracker.c b/src/backends/meta-cursor-tracker.c
index 4cbe0ec45..45291e286 100644
--- a/src/backends/meta-cursor-tracker.c
+++ b/src/backends/meta-cursor-tracker.c
@@ -167,6 +167,14 @@ meta_cursor_tracker_class_init (MetaCursorTrackerClass *klass)
                                           NULL, NULL, NULL,
                                           G_TYPE_NONE, 0);
 
+  /**
+   * MetaCursorTracker::cursor-moved:
+   * @cursor: The #MetaCursorTracker
+   * @x: The new X coordinate of the cursor
+   * @y: The new Y coordinate of the cursor
+   *
+   * Notifies when the cursor has moved to a new location.
+   */
   signals[CURSOR_MOVED] = g_signal_new ("cursor-moved",
                                         G_TYPE_FROM_CLASS (klass),
                                         G_SIGNAL_RUN_LAST,


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