luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-24 14:36:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GFileMonitor SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 13:41:32 +01:00
parent c8abf62ff1
commit 4f9b00907e
2 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gfilemonitor.c
View File

@ -31,23 +31,20 @@
#include "glibintl.h"
/**
* SECTION:gfilemonitor
* @short_description: File Monitor
* @include: gio/gio.h
* GFileMonitor:
*
* Monitors a file or directory for changes.
*
* To obtain a #GFileMonitor for a file or directory, use
* g_file_monitor(), g_file_monitor_file(), or
* g_file_monitor_directory().
* To obtain a `GFileMonitor` for a file or directory, use
* [method@Gio.File.monitor], [method@Gio.File.monitor_file], or
* [method@Gio.File.monitor_directory].
*
* To get informed about changes to the file or directory you are
* monitoring, connect to the #GFileMonitor::changed signal. The
* signal will be emitted in the
* [thread-default main context][g-main-context-push-thread-default]
* of the thread that the monitor was created in
* (though if the global default main context is blocked, this may
* cause notifications to be blocked even if the thread-default
* monitoring, connect to the [signal@Gio.FileMonitor::changed] signal. The
* signal will be emitted in the thread-default main context (see
* [method@GLib.MainContext.push_thread_default]) of the thread that the monitor
* was created in (though if the global default main context is blocked, this
* may cause notifications to be blocked even if the thread-default
* context is still running).
**/

5
gio/gfilemonitor.h
View File

@ -41,11 +41,6 @@ G_BEGIN_DECLS
typedef struct _GFileMonitorClass GFileMonitorClass;
typedef struct _GFileMonitorPrivate GFileMonitorPrivate;
/**
* GFileMonitor:
*
* Watches for changes to a file.
**/
struct _GFileMonitor
{
GObject parent_instance;