diff options
| author | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
|---|---|---|
| committer | Andrew Walton <awalton@src.gnome.org> | 2007-11-27 14:00:13 +0000 |
| commit | 5247f12f3649726471080440de0d37b78c1cec33 (patch) | |
| tree | 69bd070ba8cb8b12234319e354f5cb856d0c551f /gio/gfilemonitor.h | |
| parent | 6d071b4ab6d60aecf9532d1aac2128dd0c08f917 (diff) | |
| download | glib-5247f12f3649726471080440de0d37b78c1cec33.tar.gz | |
Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes.
Fixes GCancellable inaccuracies. Removes unnecessary incomplete
gtk-doc headers in private files.
svn path=/trunk/; revision=5953
Diffstat (limited to 'gio/gfilemonitor.h')
| -rw-r--r-- | gio/gfilemonitor.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/gio/gfilemonitor.h b/gio/gfilemonitor.h index edb9f64be..bb96f6cad 100644 --- a/gio/gfilemonitor.h +++ b/gio/gfilemonitor.h @@ -35,6 +35,18 @@ G_BEGIN_DECLS #define G_IS_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR)) #define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass)) +/** + * GFileMonitorEvent: + * @G_FILE_MONITOR_EVENT_CHANGED: Monitor file changed events. + * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: Monitor file changed done events. + * @G_FILE_MONITOR_EVENT_DELETED: Monitors file deleted events. + * @G_FILE_MONITOR_EVENT_CREATED: Monitors file created events. + * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: Monitors file attribute changed events. + * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: Monitors pre-unmount events. + * @G_FILE_MONITOR_EVENT_UNMOUNTED: Monitors unmount events. + * + * Flags used when creating a #GFileMonitor to define what events to monitor for. + **/ typedef enum { G_FILE_MONITOR_EVENT_CHANGED, G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT, @@ -48,6 +60,11 @@ typedef enum { typedef struct _GFileMonitorClass GFileMonitorClass; typedef struct _GFileMonitorPrivate GFileMonitorPrivate; +/** + * GFileMonitor: + * + * Watches for changes within a #GFile. + **/ struct _GFileMonitor { GObject parent; @@ -69,7 +86,7 @@ struct _GFileMonitorClass /* Virtual Table */ gboolean (*cancel)(GFileMonitor* monitor); - + /*< private >*/ /* Padding for future expansion */ void (*_g_reserved1) (void); void (*_g_reserved2) (void); |