X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=libudev%2Flibudev-list.c;h=f6637fc92d9950bbe1553908c12e31a464b7f788;hp=182d75aa8a201d116f0fdb4c1231b6d6a318aa4a;hb=7d701b0e26f96c279ef9ba8e4ef82fc4fca56acf;hpb=48a9b173e88738ff4eefb3519f1d27711b417c8d

diff --git a/libudev/libudev-list.c b/libudev/libudev-list.c
index 182d75aa8..f6637fc92 100644
--- a/libudev/libudev-list.c
+++ b/libudev/libudev-list.c
@@ -19,6 +19,19 @@
 #include "libudev.h"
 #include "libudev-private.h"
 
+/**
+ * SECTION:libudev-list
+ * @short_description: list operation
+ *
+ * Libudev list operations.
+ */
+
+/**
+ * udev_list_entry:
+ *
+ * Opaque object representing one entry in a list. An entry contains
+ * contains a name, and optionally a value.
+ */
 struct udev_list_entry {
 	struct udev_list_node node;
 	struct udev *udev;
@@ -180,6 +193,12 @@ struct udev_list_entry *udev_list_get_entry(struct udev_list_node *list)
 	return list_node_to_entry(list->next);
 }
 
+/**
+ * udev_list_entry_get_next:
+ * @list_entry: current entry
+ *
+ * Returns: the next entry from the list, #NULL is no more entries are found.
+ */
 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry)
 {
 	struct udev_list_node *next;
@@ -193,6 +212,13 @@ struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_en
 	return list_node_to_entry(next);
 }
 
+/**
+ * udev_list_entry_get_by_name:
+ * @list_entry: current entry
+ * @name: name string to match
+ *
+ * Returns: the entry where @name matched, #NULL if no matching entry is found.
+ */
 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name)
 {
 	struct udev_list_entry *entry;
@@ -206,6 +232,12 @@ struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list
 	return NULL;
 }
 
+/**
+ * udev_list_entry_get_name:
+ * @list_entry: current entry
+ *
+ * Returns: the name string of this entry.
+ */
 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry)
 {
 	if (list_entry == NULL)
@@ -213,6 +245,12 @@ const char *udev_list_entry_get_name(struct udev_list_entry *list_entry)
 	return list_entry->name;
 }
 
+/**
+ * udev_list_entry_get_value:
+ * @list_entry: current entry
+ *
+ * Returns: the value string of this entry.
+ */
 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry)
 {
 	if (list_entry == NULL)