summaryrefslogtreecommitdiff
path: root/libudev/libudev.h
diff options
context:
space:
mode:
authorKay Sievers <kay.sievers@vrfy.org>2009-06-15 13:22:38 +0200
committerKay Sievers <kay.sievers@vrfy.org>2009-06-15 13:22:38 +0200
commit1e5113228f8c5cde04b03616485e0c4ce54c3320 (patch)
tree4c5fdb6d5c352c021c84a59224bb5c80eefb355b /libudev/libudev.h
parent26812f0a13eacb8615f66f9048cd9575b2b8a2cf (diff)
libudev: update documentation
Diffstat (limited to 'libudev/libudev.h')
-rw-r--r--libudev/libudev.h15
1 files changed, 11 insertions, 4 deletions
diff --git a/libudev/libudev.h b/libudev/libudev.h
index ffeb80f8d3..8b5391c066 100644
--- a/libudev/libudev.h
+++ b/libudev/libudev.h
@@ -47,10 +47,17 @@ struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_en
struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name);
const char *udev_list_entry_get_name(struct udev_list_entry *list_entry);
const char *udev_list_entry_get_value(struct udev_list_entry *list_entry);
-#define udev_list_entry_foreach(entry, first) \
- for (entry = first; \
- entry != NULL; \
- entry = udev_list_entry_get_next(entry))
+/**
+ * udev_list_entry_foreach:
+ * @list_entry: entry to store the current position
+ * @first_entry: first entry to start with
+ *
+ * Helper to iterate over all entries of a list.
+ */
+#define udev_list_entry_foreach(list_entry, first_entry) \
+ for (list_entry = first_entry; \
+ list_entry != NULL; \
+ list_entry = udev_list_entry_get_next(list_entry))
/*
* udev_device