Commits

Kay Sievers  committed ed8deac

docs: hook-up gtk-doc to 'make check'

  • Participants
  • Parent commits cb641e8

Comments (0)

Files changed (4)

File src/libudev-device.c

  * udev_device_get_devnum:
  * @udev_device: udev device
  *
- * Returns: the device major/minor number.
+ * Get the device major/minor number.
+ *
+ * Returns: the dev_t number.
  **/
 UDEV_EXPORT dev_t udev_device_get_devnum(struct udev_device *udev_device)
 {
  * udev_device_get_driver:
  * @udev_device: udev device
  *
- * Returns: the driver string, or #NULL if there is no driver attached.
+ * Get the kernel driver name.
+ *
+ * Returns: the driver name string, or #NULL if there is no driver attached.
  **/
 UDEV_EXPORT const char *udev_device_get_driver(struct udev_device *udev_device)
 {
  * @udev_device: udev device
  * @key: property name
  *
- * Returns: the value of a device property, or #NULL if there is no such property.
+ * Get the value of a given property.
+ *
+ * Returns: the property string, or #NULL if there is no such property.
  **/
 UDEV_EXPORT const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key)
 {
  * udev_device_get_sysname:
  * @udev_device: udev device
  *
- * Returns: the sys name of the device device
+ * Get the kernel device name in /sys.
+ *
+ * Returns: the name string of the device device
  **/
 UDEV_EXPORT const char *udev_device_get_sysname(struct udev_device *udev_device)
 {
  * udev_device_get_sysnum:
  * @udev_device: udev device
  *
- * Returns: the trailing number of of the device name
+ * Get the instance number of the device.
+ *
+ * Returns: the trailing number string of of the device name
  **/
 UDEV_EXPORT const char *udev_device_get_sysnum(struct udev_device *udev_device)
 {
         return udev_list_get_entry(&udev_device->tags_list);
 }
 
+/**
+ * udev_device_has_tag:
+ * @udev_device: udev device
+ * @tag: tag name
+ *
+ * Check if a given device has a certain tag associated.
+ *
+ * Returns: 1 if the tag is found. 0 otherwise.
+ **/
 UDEV_EXPORT int udev_device_has_tag(struct udev_device *udev_device, const char *tag)
 {
         struct udev_list_entry *list_entry;

File src/libudev-enumerate.c

  * udev_enumerate_new:
  * @udev: udev library context
  *
- * Returns: an enumeration context
+ * Create an enumeration context to scan /sys.
+ *
+ * Returns: an enumeration context.
  **/
 UDEV_EXPORT struct udev_enumerate *udev_enumerate_new(struct udev *udev)
 {
  * udev_enumerate_get_udev:
  * @udev_enumerate: context
  *
- * Returns: the udev library context.
+ * Get the udev library context.
+ *
+ * Returns: a pointer to the context.
  */
 UDEV_EXPORT struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate)
 {
  * udev_enumerate_get_list_entry:
  * @udev_enumerate: context
  *
- * Returns: the first entry of the sorted list of device paths.
+ * Get the first entry of the sorted list of device paths.
+ *
+ * Returns: a udev_list_entry.
  */
 UDEV_EXPORT struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate)
 {
  * @udev_enumerate: context
  * @subsystem: filter for a subsystem of the device to include in the list
  *
+ * Match only devices belonging to a certain kernel subsystem.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem)
  * @udev_enumerate: context
  * @subsystem: filter for a subsystem of the device to exclude from the list
  *
+ * Match only devices not belonging to a certain kernel subsystem.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem)
  * @sysattr: filter for a sys attribute at the device to include in the list
  * @value: optional value of the sys attribute
  *
+ * Match only devices with a certain /sys device attribute.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value)
  * @sysattr: filter for a sys attribute at the device to exclude from the list
  * @value: optional value of the sys attribute
  *
+ * Match only devices not having a certain /sys device attribute.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value)
  * @property: filter for a property of the device to include in the list
  * @value: value of the property
  *
+ * Match only devices with a certain property.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value)
  * @udev_enumerate: context
  * @tag: filter for a tag of the device to include in the list
  *
+ * Match only devices with a certain tag.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_match_tag(struct udev_enumerate *udev_enumerate, const char *tag)
  * @udev_enumerate: context
  * @sysname: filter for the name of the device to include in the list
  *
+ * Match only devices with a given /sys device name.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  */
 UDEV_EXPORT int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname)
  * udev_enumerate_scan_devices:
  * @udev_enumerate: udev enumeration context
  *
+ * Scan /sys for all devices which match the given filters. No matches
+ * will return all currently available devices.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  **/
 UDEV_EXPORT int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate)
  * udev_enumerate_scan_subsystems:
  * @udev_enumerate: udev enumeration context
  *
+ * Scan /sys for all kernel subsystems, including buses, classes, drivers.
+ *
  * Returns: 0 on success, otherwise a negative error value.
  **/
 UDEV_EXPORT int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate)

File src/libudev-list.c

  * 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.
  */
 UDEV_EXPORT struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *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.
  */
 UDEV_EXPORT struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name)
 {
  * udev_list_entry_get_name:
  * @list_entry: current entry
  *
+ * Get the name of a list entry.
+ *
  * Returns: the name string of this entry.
  */
 UDEV_EXPORT 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.
  */
 UDEV_EXPORT const char *udev_list_entry_get_value(struct udev_list_entry *list_entry)

File src/libudev-queue.c

  * udev_queue_get_kernel_seqnum:
  * @udev_queue: udev queue context
  *
- * Returns: the current kernel event sequence number.
+ * Get the current kernel event sequence number.
+ *
+ * Returns: the sequence number.
  **/
 UDEV_EXPORT unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue)
 {
  * udev_queue_get_udev_seqnum:
  * @udev_queue: udev queue context
  *
- * Returns: the last known udev event sequence number.
+ * Get the last known udev event sequence number.
+ *
+ * Returns: the sequence number.
  **/
 UDEV_EXPORT unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue)
 {
  * udev_queue_get_udev_is_active:
  * @udev_queue: udev queue context
  *
+ * Check if udev is active on the system.
+ *
  * Returns: a flag indicating if udev is active.
  **/
 UDEV_EXPORT int udev_queue_get_udev_is_active(struct udev_queue *udev_queue)
  * udev_queue_get_queue_is_empty:
  * @udev_queue: udev queue context
  *
+ * Check if udev is currently processing any events.
+ *
  * Returns: a flag indicating if udev is currently handling events.
  **/
 UDEV_EXPORT int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue)
  * @start: first event sequence number
  * @end: last event sequence number
  *
+ * Check if udev is currently processing any events in a given sequence number range.
+ *
  * Returns: a flag indicating if any of the sequence numbers in the given range is currently active.
  **/
 UDEV_EXPORT int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
  * @udev_queue: udev queue context
  * @seqnum: sequence number
  *
+ * Check if udev is currently processing a given sequence number.
+ *
  * Returns: a flag indicating if the given sequence number is currently active.
  **/
 UDEV_EXPORT int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum)
  * udev_queue_get_queued_list_entry:
  * @udev_queue: udev queue context
  *
- * Returns: the first entry of the list of queued events.
+ * Get the first entry of the list of queued events.
+ *
+ * Returns: a udev_list_entry.
  **/
 UDEV_EXPORT struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue)
 {