summaryrefslogtreecommitdiff
path: root/libudev/libudev-device.c
diff options
context:
space:
mode:
authorKay Sievers <kay.sievers@vrfy.org>2009-06-15 17:09:43 +0200
committerKay Sievers <kay.sievers@vrfy.org>2009-06-15 17:09:43 +0200
commitce1d6d7fb47582588cfbcf0baba0c58e42a90ca6 (patch)
tree0078d9b69ff4b6dfccca9871dbe421a64ed4cf01 /libudev/libudev-device.c
parent1e5113228f8c5cde04b03616485e0c4ce54c3320 (diff)
libudev: doc - add section headers
Diffstat (limited to 'libudev/libudev-device.c')
-rw-r--r--libudev/libudev-device.c14
1 files changed, 12 insertions, 2 deletions
diff --git a/libudev/libudev-device.c b/libudev/libudev-device.c
index aef6256734..9965972b32 100644
--- a/libudev/libudev-device.c
+++ b/libudev/libudev-device.c
@@ -24,9 +24,19 @@
#include "libudev-private.h"
/**
+ * SECTION:libudev-device
+ * @short_description: kernel sys devices
+ *
+ * Representation of kernel sys devices. Devices are uniquely identified
+ * by their syspath, every device has exactly one path in the kernel sys
+ * filesystem. Devices usually belong to a kernel subsystem, and and have
+ * a unique name inside that subsytem.
+ */
+
+/**
* udev_device:
*
- * Representation of a kernel sys device.
+ * Opaque object representing one kernel sys device.
*/
struct udev_device {
struct udev *udev;
@@ -882,7 +892,7 @@ struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device
* udev_device_get_driver:
* @udev_device: udev device
*
- * Returns: the driver string or #NULL, if ther is no driver attached.
+ * Returns: the driver string, or #NULL if there is no driver attached.
**/
const char *udev_device_get_driver(struct udev_device *udev_device)
{