summaryrefslogtreecommitdiff
path: root/src/libudev/libudev-list.c
diff options
context:
space:
mode:
authorKay Sievers <kay@vrfy.org>2012-04-20 03:25:36 +0200
committerKay Sievers <kay@vrfy.org>2012-04-20 03:25:36 +0200
commit21dbe43aece5b6fc87860de175f067b56649e7d1 (patch)
treee57256a49cb54eb61ba03b01ce5c199e2b8d4a08 /src/libudev/libudev-list.c
parent80037e4d17d0c8f28d0ff610902babc9e2b4e2f9 (diff)
docs: hook-up gtk-doc to 'make check'
Diffstat (limited to 'src/libudev/libudev-list.c')
-rw-r--r--src/libudev/libudev-list.c12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/libudev/libudev-list.c b/src/libudev/libudev-list.c
index 054c0a931c..1fe46f3f28 100644
--- a/src/libudev/libudev-list.c
+++ b/src/libudev/libudev-list.c
@@ -261,7 +261,9 @@ struct udev_list_entry *udev_list_get_entry(struct udev_list *list)
* udev_list_entry_get_next:
* @list_entry: current entry
*
- * Returns: the next entry from the list, #NULL is no more entries are found.
+ * Get the next entry from the list.
+ *
+ * Returns: udev_list_entry, #NULL if no more entries are available.
*/
_public_ struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry)
{
@@ -281,7 +283,9 @@ _public_ struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry
* @list_entry: current entry
* @name: name string to match
*
- * Returns: the entry where @name matched, #NULL if no matching entry is found.
+ * Lookup an entry in the list with a certain name.
+ *
+ * Returns: udev_list_entry, #NULL if no matching entry is found.
*/
_public_ struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name)
{
@@ -303,6 +307,8 @@ _public_ struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_en
* udev_list_entry_get_name:
* @list_entry: current entry
*
+ * Get the name of a list entry.
+ *
* Returns: the name string of this entry.
*/
_public_ const char *udev_list_entry_get_name(struct udev_list_entry *list_entry)
@@ -316,6 +322,8 @@ _public_ const char *udev_list_entry_get_name(struct udev_list_entry *list_entry
* udev_list_entry_get_value:
* @list_entry: current entry
*
+ * Get the value of list entry.
+ *
* Returns: the value string of this entry.
*/
_public_ const char *udev_list_entry_get_value(struct udev_list_entry *list_entry)