libudev: doc - add section headers

[elogind.git] / libudev / libudev-device.c

diff --git a/libudev/libudev-device.c b/libudev/libudev-device.c
index aef62567341136bdd5d92795a01cbfa2582c48d2..9965972b3288c5c1a58b5273e0d7347f86a6b822 100644 (file)
--- a/libudev/libudev-device.c
+++ b/libudev/libudev-device.c
@@ -23,10 +23,20 @@
 #include "libudev.h"
 #include "libudev-private.h"
 
 #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:
  *
 /**
  * udev_device:
  *

- * Representation of a kernel sys device.
+ * Opaque object representing one kernel sys device.

  */
 struct udev_device {
        struct udev *udev;
  */
 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
  *
  * 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)
 {
  **/
 const char *udev_device_get_driver(struct udev_device *udev_device)
 {