Fixes GB#530786: GFileMonitor 'changed' signal underdocumented
authorAleksander Morgado <aleksander@lanedo.com>
Thu, 25 Nov 2010 17:38:33 +0000 (18:38 +0100)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 28 Nov 2010 23:20:59 +0000 (18:20 -0500)
gio/gfilemonitor.c

index 726cd62..f7a87b6 100644 (file)
@@ -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"),