diff options
| author | Kay Sievers <kay.sievers@vrfy.org> | 2009-06-15 13:22:38 +0200 |
|---|---|---|
| committer | Kay Sievers <kay.sievers@vrfy.org> | 2009-06-15 13:22:38 +0200 |
| commit | 1e5113228f8c5cde04b03616485e0c4ce54c3320 (patch) | |
| tree | 4c5fdb6d5c352c021c84a59224bb5c80eefb355b /libudev/libudev-list.c | |
| parent | 26812f0a13eacb8615f66f9048cd9575b2b8a2cf (diff) | |
libudev: update documentation
Diffstat (limited to 'libudev/libudev-list.c')
| -rw-r--r-- | libudev/libudev-list.c | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/libudev/libudev-list.c b/libudev/libudev-list.c index 182d75aa8a..bd9792ad6c 100644 --- a/libudev/libudev-list.c +++ b/libudev/libudev-list.c @@ -19,6 +19,11 @@ #include "libudev.h" #include "libudev-private.h" +/** + * udev_list_entry: + * + * One entry in a list, containing a name and an optional value. + */ struct udev_list_entry { struct udev_list_node node; struct udev *udev; @@ -180,6 +185,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 +204,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 +224,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 +237,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) |