[libdazzle] recursive-monitor: add some docs



commit 10e8cd9ee5be8114ba82446f219de318b0811f33
Author: Christian Hergert <chergert redhat com>
Date:   Thu Nov 30 00:14:56 2017 -0800

    recursive-monitor: add some docs

 src/files/dzl-recursive-file-monitor.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/src/files/dzl-recursive-file-monitor.c b/src/files/dzl-recursive-file-monitor.c
index c7bf08f..cace697 100644
--- a/src/files/dzl-recursive-file-monitor.c
+++ b/src/files/dzl-recursive-file-monitor.c
@@ -21,6 +21,21 @@
 #include "files/dzl-recursive-file-monitor.h"
 #include "util/dzl-macros.h"
 
+/**
+ * SECTION:dzl-recursive-file-monitor
+ * @title: DzlRecursiveFileMonitor
+ * @short_description: a recursive directory monitor
+ *
+ * This works by creating a #GFileMonitor for each directory underneath a root
+ * directory (and recursively beyond that).
+ *
+ * This is only designed for use on Linux, where we are using a single inotify
+ * FD. You can still hit the max watch limit, but it is much higher than the FD
+ * limit.
+ *
+ * Since: 3.28
+ */
+
 struct _DzlRecursiveFileMonitor
 {
   GObject       parent_instance;


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