Commits

consus committed 0c08ee1

docs: cosmetic changes

Comments (0)

Files changed (3)

src/gudev/gudevclient.c

  *
  * Device information is retrieved from the kernel (through the sysfs
  * filesystem) and the udev daemon (through a tmpfs filesystem) and presented
- * through #GUdevDevice objects. This means that no blocking IO ever happens
- * (in both cases, we are essentially just reading data from kernel memory) and
- * as such there are no asynchronous versions of the provided methods.
+ * through #GUdevDevice objects. This means that no blocking
+ * IO ever happens (in both cases, we are essentially just reading data from
+ * kernel memory) and as such there are no asynchronous versions of the
+ * provided methods.
  *
  * To get #GUdevDevice objects, use
- * g_udev_client_query_by_subsystem(),
- * g_udev_client_query_by_device_number(),
- * g_udev_client_query_by_device_file(),
- * g_udev_client_query_by_sysfs_path(),
- * g_udev_client_query_by_subsystem_and_name()
+ *
+ * - g_udev_client_query_by_subsystem(),
+ * - g_udev_client_query_by_device_number(),
+ * - g_udev_client_query_by_device_file(),
+ * - g_udev_client_query_by_sysfs_path(),
+ * - g_udev_client_query_by_subsystem_and_name().
+ *
  * or the #GUdevEnumerator type.
  *
  * To listen to uevents, connect to the #GUdevClient::uevent signal.

src/gudev/gudevdevice.c

  * @brief Get information about a device
  *
  * The #GUdevDevice class is used to get information about a specific
- * device. Note that you cannot instantiate a #GUdevDevice object
- * yourself. Instead you must use #GUdevClient to obtain #GUdevDevice
- * objects.
+ * device.
+ *
+ * @note You cannot instantiate a #GUdevDevice object yourself.\n
+ * Instead you must use #GUdevClient to obtain #GUdevDevice objects.
  *
  * To get basic information about a device, use
- * g_udev_device_get_subsystem(), g_udev_device_get_devtype(),
- * g_udev_device_get_name(), g_udev_device_get_number(),
- * g_udev_device_get_sysfs_path(), g_udev_device_get_driver(),
- * g_udev_device_get_action(), g_udev_device_get_seqnum(),
- * g_udev_device_get_device_type(), g_udev_device_get_device_number(),
- * g_udev_device_get_device_file(),
- * g_udev_device_get_device_file_symlinks().
  *
- * To navigate the device tree, use g_udev_device_get_parent() and
- * g_udev_device_get_parent_with_subsystem().
+ * - g_udev_device_get_subsystem(),
+ * - g_udev_device_get_devtype(),
+ * - g_udev_device_get_name(),
+ * - g_udev_device_get_number(),
+ * - g_udev_device_get_sysfs_path(),
+ * - g_udev_device_get_driver(),
+ * - g_udev_device_get_action(),
+ * - g_udev_device_get_seqnum(),
+ * - g_udev_device_get_device_type(),
+ * - g_udev_device_get_device_number(),
+ * - g_udev_device_get_device_file(),
+ * - g_udev_device_get_device_file_symlinks().
+ *
+ * To navigate the device tree, use
+ *
+ * - g_udev_device_get_parent(),
+ * - g_udev_device_get_parent_with_subsystem().
  *
  * To access udev properties for the device, use
- * g_udev_device_get_property_keys(),
- * g_udev_device_has_property(),
- * g_udev_device_get_property(),
- * g_udev_device_get_property_as_int(),
- * g_udev_device_get_property_as_uint64(),
- * g_udev_device_get_property_as_double(),
- * g_udev_device_get_property_as_boolean() and
- * g_udev_device_get_property_as_strv().
+ *
+ * - g_udev_device_get_property_keys(),
+ * - g_udev_device_has_property(),
+ * - g_udev_device_get_property(),
+ * - g_udev_device_get_property_as_int(),
+ * - g_udev_device_get_property_as_uint64(),
+ * - g_udev_device_get_property_as_double(),
+ * - g_udev_device_get_property_as_boolean(),
+ * - g_udev_device_get_property_as_strv().
  *
  * To access sysfs attributes for the device, use
- * g_udev_device_get_sysfs_attr(),
- * g_udev_device_get_sysfs_attr_as_int(),
- * g_udev_device_get_sysfs_attr_as_uint64(),
- * g_udev_device_get_sysfs_attr_as_double(),
- * g_udev_device_get_sysfs_attr_as_boolean() and
- * g_udev_device_get_sysfs_attr_as_strv().
- *
- * Note that all getters on #GUdevDevice are non-reffing – returned
- * values are owned by the object, should not be freed and are only
- * valid as long as the object is alive.
- *
- * By design, #GUdevDevice will not react to changes for a device – it
- * only contains a snapshot of information when the #GUdevDevice
- * object was created. To work with changes, you typically connect to
- * the #GUdevClient::uevent signal on a #GUdevClient and get a new
- * #GUdevDevice whenever an event happens.
+ *
+ * - g_udev_device_get_sysfs_attr(),
+ * - g_udev_device_get_sysfs_attr_as_int(),
+ * - g_udev_device_get_sysfs_attr_as_uint64(),
+ * - g_udev_device_get_sysfs_attr_as_double(),
+ * - g_udev_device_get_sysfs_attr_as_boolean(),
+ * - g_udev_device_get_sysfs_attr_as_strv().
+ *
+ * Note that all getters on #GUdevDevice are non-reffing – returned values are
+ * owned by the object, should not be freed and are only valid as long as the
+ * object is alive.
+ *
+ * By design, #GUdevDevice will not react to changes for a device – it only
+ * contains a snapshot of information when the #GUdevDevice object was created.
+ * To work with changes, you typically connect to the #GUdevClient::uevent
+ * signal on a #GUdevClient and get a new #GUdevDevice whenever an event
+ * happens.
  */
 
 /* @{ -- gudevdevice group */
  * @param udev udev library context
  * @param userdata data pointer
  *
- * Store custom @userdata in the library context.
+ * Store custom userdata in the library context.
  */
 UDEV_EXPORT void udev_set_userdata(struct udev *udev, void *userdata)
 {
  *
  * Drop a reference of the udev library context. If the refcount
  * reaches zero, the resources of the context will be released.
- *
  */
 UDEV_EXPORT struct udev *udev_unref(struct udev *udev)
 {
  * The built-in logging writes to stderr. It can be
  * overridden by a custom function, to plug log messages
  * into the users' logging functionality.
- *
  */
 UDEV_EXPORT void udev_set_log_fn(struct udev *udev,
                      void (*log_fn)(struct udev *udev,