chiark / gitweb /
do not rename the database on device rename
[elogind.git] / libudev / libudev-list.c
index 182d75aa8a201d116f0fdb4c1231b6d6a318aa4a..b5e96458cc26657d3333b39b5ef2734f65531ae4 100644 (file)
 #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;
        struct udev_list_node *list;
        char *name;
        char *value;
-       int flag;
+       unsigned int flags;
 };
 
 /* list head point to itself if empty */
@@ -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)
@@ -220,16 +258,16 @@ const char *udev_list_entry_get_value(struct udev_list_entry *list_entry)
        return list_entry->value;
 }
 
-int udev_list_entry_get_flag(struct udev_list_entry *list_entry)
+unsigned int udev_list_entry_get_flags(struct udev_list_entry *list_entry)
 {
        if (list_entry == NULL)
                return -EINVAL;
-       return list_entry->flag;
+       return list_entry->flags;
 }
 
-void udev_list_entry_set_flag(struct udev_list_entry *list_entry, int flag)
+void udev_list_entry_set_flags(struct udev_list_entry *list_entry, unsigned int flags)
 {
        if (list_entry == NULL)
                return;
-       list_entry->flag = flag;
+       list_entry->flags = flags;
 }