[glib] Fixes GB#530786: GFileMonitor 'changed' signal underdocumented



commit 51894b7dd06a3b50654f9ce1fadff418d917aca1
Author: Aleksander Morgado <aleksander lanedo com>
Date:   Thu Nov 25 18:38:33 2010 +0100

    Fixes GB#530786: GFileMonitor 'changed' signal underdocumented

 gio/gfilemonitor.c |   12 +++++++++---
 1 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/gio/gfilemonitor.c b/gio/gfilemonitor.c
index 726cd62..f7a87b6 100644
--- a/gio/gfilemonitor.c
+++ b/gio/gfilemonitor.c
@@ -224,10 +224,16 @@ g_file_monitor_class_init (GFileMonitorClass *klass)
    * GFileMonitor::changed:
    * @monitor: a #GFileMonitor.
    * @file: a #GFile.
-   * @other_file: a #GFile.
+   * @other_file: a #GFile or #NULL.
    * @event_type: a #GFileMonitorEvent.
-   * 
-   * Emitted when a file has been changed. 
+   *
+   * Emitted when @file has been changed.
+   *
+   * If using #G_FILE_MONITOR_SEND_MOVED flag and @event_type is
+   * #G_FILE_MONITOR_SEND_MOVED, @file will be set to a #GFile containing the
+   * old path, and @other_file will be set to a #GFile containing the new path.
+   *
+   * In all the other cases, @other_file will be set to #NULL.
    **/
   signals[CHANGED] =
     g_signal_new (I_("changed"),



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