X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=libudev%2Flibudev-device.c;h=669c51e35bb7617f24bfb153d0b4061003603dda;hp=aef62567341136bdd5d92795a01cbfa2582c48d2;hb=2417dc20f5147556d0ed4f95a37b1547fb4b0f2b;hpb=1e5113228f8c5cde04b03616485e0c4ce54c3320 diff --git a/libudev/libudev-device.c b/libudev/libudev-device.c index aef625673..669c51e35 100644 --- a/libudev/libudev-device.c +++ b/libudev/libudev-device.c @@ -23,10 +23,20 @@ #include "libudev.h" #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; @@ -582,7 +592,7 @@ struct udev_device *udev_device_get_parent(struct udev_device *udev_device) * It can be called as many times as needed, without caring about * references. * - * Returns: a new udev device, or #NULL, if no matching parent exists. + * Returns: a new udev device, or #NULL if no matching parent exists. **/ struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device, const char *subsystem, const char *devtype) { @@ -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) {