Commits

consus committed 68c9df9

docs: replace gtk-doc with doxygen (Part II)

Migration for libgudev is done. Still no Makefiles, but... Screw you
guys, i'm going to get some sleep.

Comments (0)

Files changed (12)

doc/gudev/.gitignore

-gudev-overrides.txt
-gudev-decl-list.txt
-gudev-decl.txt
-gudev-undeclared.txt
-gudev-undocumented.txt
-gudev-unused.txt
-gudev.args
-gudev.hierarchy
-gudev.interfaces
-gudev.prerequisites
-gudev.signals
-html.stamp
-html/*
-xml/*
-tmpl/*
-*.stamp

doc/gudev/Doxyfile.in

+# Configuration file for doxygen
+
+DOXYFILE_ENCODING       = UTF-8
+
+PROJECT_NAME            = "gudev"
+PROJECT_BRIEF           = "GObject bindings for libudev"
+PROJECT_NUMBER          = "ver. @VERSION@"
+
+OUTPUT_LANGUAGE         = English
+
+GENERATE_HTML           = YES
+GENERATE_LATEX          = NO
+GENERATE_MAN            = NO
+GENERATE_RTF	        = NO
+
+GENERATE_LEGEND         = YES
+
+SHORT_NAMES             = NO
+FULL_PATH_NAMES         = NO
+CASE_SENSE_NAMES        = NO
+TAB_SIZE                = 4
+INPUT_ENCODING          = UTF-8
+
+INPUT                   = mainpage.doxygen ../../src/gudev
+RECURSIVE	            = NO
+FILE_PATTERNS           = gudev*.c
+EXCLUDE_PATTERNS        = *private.c
+
+EXTRACT_ALL	            = NO
+EXTRACT_STATIC	        = NO
+
+SHOW_INCLUDE_FILES      = NO
+JAVADOC_AUTOBRIEF       = NO
+INHERIT_DOCS	        = YES
+
+MACRO_EXPANSION         = NO
+EXPAND_ONLY_PREDEF      = NO
+
+SORT_GROUP_NAMES        = YES
+
+OPTIMIZE_OUTPUT_FOR_C   = YES

doc/gudev/Makefile.am

-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.10 at least.
-AUTOMAKE_OPTIONS = 1.10
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=gudev
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=2
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=$(top_srcdir)/src
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=g_udev
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkhtml
-MKHTML_OPTIONS=--path=$(abs_srcdir) --path=$(abs_builddir)
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/src/gudev/*.h
-CFILE_GLOB=$(top_srcdir)/src/gudev/*.c
-
-# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
-# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
-EXTRA_HFILES=
-
-# Header files to ignore when scanning. Use base file name, no paths
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files = version.xml
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS = \
-        $(DBUS_GLIB_CFLAGS) \
-        $(GLIB_CFLAGS) \
-        -I$(top_srcdir)/src/gudev \
-        -I$(top_builddir)/src/gudev
-
-GTKDOC_LIBS = \
-        $(GLIB_LIBS) \
-        $(top_builddir)/libgudev-1.0.la
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += version.xml.in
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Comment this out if you want your docs-status tested during 'make check'
-if ENABLE_GTK_DOC
-#TESTS_ENVIRONMENT = cd $(srcsrc)
-#TESTS = $(GTKDOC_CHECK)
-endif

doc/gudev/gudev-docs.xml

-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-<!ENTITY version SYSTEM "version.xml">
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-  <bookinfo>
-    <title>GUDev Reference Manual</title>
-    <releaseinfo>For GUdev version &version;</releaseinfo>
-    <authorgroup>
-      <author>
-        <firstname>David</firstname>
-        <surname>Zeuthen</surname>
-        <affiliation>
-          <address>
-            <email>davidz@redhat.com</email>
-          </address>
-        </affiliation>
-      </author>
-      <author>
-        <firstname>Bastien</firstname>
-        <surname>Nocera</surname>
-        <affiliation>
-          <address>
-            <email>hadess@hadess.net</email>
-          </address>
-        </affiliation>
-      </author>
-    </authorgroup>
-
-    <copyright>
-      <year>2011</year>
-      <holder>The GUDev Authors</holder>
-    </copyright>
-
-    <legalnotice>
-      <para>
-        Permission is granted to copy, distribute and/or modify this
-        document under the terms of the <citetitle>GNU Free
-        Documentation License</citetitle>, Version 1.1 or any later
-        version published by the Free Software Foundation with no
-        Invariant Sections, no Front-Cover Texts, and no Back-Cover
-        Texts. You may obtain a copy of the <citetitle>GNU Free
-        Documentation License</citetitle> from the Free Software
-        Foundation by visiting <ulink type="http"
-        url="http://www.fsf.org">their Web site</ulink> or by writing
-        to:
-
-        <address>
-          The Free Software Foundation, Inc.,
-          <street>59 Temple Place</street> - Suite 330,
-          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
-          <country>USA</country>
-        </address>
-      </para>
-
-      <para>
-        Many of the names used by companies to distinguish their
-        products and services are claimed as trademarks. Where those
-        names appear in any freedesktop.org documentation, and those
-        trademarks are made aware to the members of the
-        freedesktop.org Project, the names have been printed in caps
-        or initial caps.
-      </para>
-    </legalnotice>
-  </bookinfo>
-
-  <reference id="ref-API">
-    <title>API Reference</title>
-    <partintro>
-      <para>
-        This part presents the class and function reference for the
-        <literal>libgudev</literal> library.
-      </para>
-    </partintro>
-    <xi:include href="xml/gudevclient.xml"/>
-    <xi:include href="xml/gudevdevice.xml"/>
-    <xi:include href="xml/gudevenumerator.xml"/>
-  </reference>
-
-  <chapter id="gudev-hierarchy">
-    <title>Object Hierarchy</title>
-      <xi:include href="xml/tree_index.sgml"/>
-  </chapter>
-  <index>
-    <title>Index</title>
-  </index>
-  <index role="165">
-    <title>Index of new symbols in 165</title>
-    <xi:include href="xml/api-index-165.xml"><xi:fallback /></xi:include>
-  </index>
-
-</book>

doc/gudev/gudev-sections.txt

-<SECTION>
-<FILE>gudevclient</FILE>
-<TITLE>GUdevClient</TITLE>
-GUdevClient
-GUdevClientClass
-GUdevDeviceType
-GUdevDeviceNumber
-g_udev_client_new
-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
-<SUBSECTION Standard>
-G_UDEV_CLIENT
-G_UDEV_IS_CLIENT
-G_UDEV_TYPE_CLIENT
-g_udev_client_get_type
-G_UDEV_CLIENT_CLASS
-G_UDEV_IS_CLIENT_CLASS
-G_UDEV_CLIENT_GET_CLASS
-<SUBSECTION Private>
-GUdevClientPrivate
-</SECTION>
-
-<SECTION>
-<FILE>gudevdevice</FILE>
-<TITLE>GUdevDevice</TITLE>
-GUdevDevice
-GUdevDeviceClass
-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
-g_udev_device_get_parent
-g_udev_device_get_parent_with_subsystem
-g_udev_device_get_tags
-g_udev_device_get_is_initialized
-g_udev_device_get_usec_since_initialized
-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
-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
-<SUBSECTION Standard>
-G_UDEV_DEVICE
-G_UDEV_IS_DEVICE
-G_UDEV_TYPE_DEVICE
-g_udev_device_get_type
-G_UDEV_DEVICE_CLASS
-G_UDEV_IS_DEVICE_CLASS
-G_UDEV_DEVICE_GET_CLASS
-<SUBSECTION Private>
-GUdevDevicePrivate
-</SECTION>
-
-<SECTION>
-<FILE>gudevenumerator</FILE>
-<TITLE>GUdevEnumerator</TITLE>
-GUdevEnumerator
-GUdevEnumeratorClass
-g_udev_enumerator_new
-g_udev_enumerator_add_match_subsystem
-g_udev_enumerator_add_nomatch_subsystem
-g_udev_enumerator_add_match_sysfs_attr
-g_udev_enumerator_add_nomatch_sysfs_attr
-g_udev_enumerator_add_match_property
-g_udev_enumerator_add_match_name
-g_udev_enumerator_add_match_tag
-g_udev_enumerator_add_match_is_initialized
-g_udev_enumerator_add_sysfs_path
-g_udev_enumerator_execute
-<SUBSECTION Standard>
-G_UDEV_ENUMERATOR
-G_UDEV_IS_ENUMERATOR
-G_UDEV_TYPE_ENUMERATOR
-g_udev_enumerator_get_type
-G_UDEV_ENUMERATOR_CLASS
-G_UDEV_IS_ENUMERATOR_CLASS
-G_UDEV_ENUMERATOR_GET_CLASS
-<SUBSECTION Private>
-GUdevEnumeratorPrivate
-</SECTION>
-
-<SECTION>
-<FILE>gudevmarshal</FILE>
-<SUBSECTION Private>
-g_udev_marshal_VOID__STRING_OBJECT
-</SECTION>
-
-<SECTION>
-<FILE>gudevenumtypes</FILE>
-<SUBSECTION Private>
-G_TYPE_UDEV_DEVICE_TYPE
-g_udev_device_type_get_type
-</SECTION>

doc/gudev/gudev.types

-g_udev_device_type_get_type
-g_udev_device_get_type
-g_udev_client_get_type
-g_udev_enumerator_get_type

doc/gudev/mainpage.doxygen

+/** @mainpage
+
+This is the API reference for the libgudev library.
+
+@author David Zeuthen <davidz@redhat.com>
+@author Bastien Nocera <hadess@hadess.net>
+@copyright 2011, The GUDev Authors
+
+@par Legal notice
+
+        Permission is granted to copy, distribute and/or modify this document
+        under the terms of the GNU Free Documentation License, Version 1.1 or
+        any later version published by the Free Software Foundation with no
+        Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You
+        may obtain a copy of the GNU Free Documentation License from the Free
+        Software Foundation by visiting their web site or by writing to: The
+        Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+        02111-1307, USA.
+
+        Many of the names used by companies to distinguish their
+        products and services are claimed as trademarks. Where those
+        names appear in any freedesktop.org documentation, and those
+        trademarks are made aware to the members of the
+        freedesktop.org Project, the names have been printed in caps
+        or initial caps.
+
+**/

doc/gudev/version.xml.in

-@VERSION@

doc/libudev/mainpage.doxygen

 /** @mainpage
 
-\copyright 2009-2011, Kay Sievers <kay.sievers@vrfy.org>
+This is the API reference for the libudev library.
 
-This is libudev external API reference.
+\copyright 2009-2011, Kay Sievers <kay.sievers@vrfy.org>
 
 **/

src/gudev/gudevclient.c

+/** @file gudevclient.c */
+
 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
  *
  * Copyright (C) 2008-2010 David Zeuthen <davidz@redhat.com>
 #include "gudevprivate.h"
 
 /**
- * SECTION:gudevclient
- * @short_description: Query devices and listen to uevents
+ * @defgroup gudevclient GUdevClient
+ * @ingroup gudev
+ * @brief Query devices and listen to uevents
  *
  * #GUdevClient is used to query information about devices on a Linux
  * system from the Linux kernel and the udev device
  * manager.
  *
- * Device information is retrieved from the kernel (through the
- * <literal>sysfs</literal> filesystem) and the udev daemon (through a
- * <literal>tmpfs</literal> 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.
+ * 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.
  *
  * To get #GUdevDevice objects, use
  * g_udev_client_query_by_subsystem(),
  * To listen to uevents, connect to the #GUdevClient::uevent signal.
  */
 
+/* @{ -- udevclient group */
+
 struct _GUdevClientPrivate
 {
   GSource *watch_source;
   gobject_class->finalize     = g_udev_client_finalize;
 
   /**
-   * GUdevClient:subsystems:
-   *
    * The subsystems to listen for uevents on.
    *
    * To listen for only a specific DEVTYPE for a given SUBSYSTEM, use
                                                        G_PARAM_READWRITE));
 
   /**
-   * GUdevClient::uevent:
-   * @client: The #GUdevClient receiving the event.
-   * @action: The action for the uevent e.g. "add", "remove", "change", "move", etc.
-   * @device: Details about the #GUdevDevice the event is for.
+   * @param client The #GUdevClient receiving the event.
+   * @param action The action for the uevent e.g. "add", "remove", "change", "move", etc.
+   * @param device Details about the #GUdevDevice the event is for.
    *
-   * Emitted when @client receives an uevent.
+   * Emitted when client receives an uevent.
    *
-   * This signal is emitted in the
-   * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
-   * of the thread that @client was created in.
+   * This signal is emitted in the thread-default main loop of the thread that
+   * client was created in.
    */
   signals[UEVENT_SIGNAL] = g_signal_new ("uevent",
                                          G_TYPE_FROM_CLASS (klass),
 }
 
 /**
- * g_udev_client_new:
- * @subsystems: (array zero-terminated=1) (element-type utf8) (transfer none) (allow-none): A %NULL terminated string array of subsystems to listen for uevents on, %NULL to not listen on uevents at all, or an empty array to listen to uevents on all subsystems. See the documentation for the #GUdevClient:subsystems property for details on this parameter.
+ * @param subsystems (array zero-terminated=1) (element-type utf8) (transfer none) (allow-none) A %NULL terminated string array of subsystems to listen for uevents on, %NULL to not listen on uevents at all, or an empty array to listen to uevents on all subsystems. See the documentation for the #GUdevClientsubsystems property for details on this parameter.
  *
- * Constructs a #GUdevClient object that can be used to query
- * information about devices. Connect to the #GUdevClient::uevent
- * signal to listen for uevents. Note that signals are emitted in the
- * <link linkend="g-main-context-push-thread-default">thread-default main loop</link>
- * of the thread that you call this constructor from.
+ * Constructs a #GUdevClient object that can be used to query information about
+ * devices. Connect to the #GUdevClient::uevent signal to listen for uevents.
+ * Note that signals are emitted in the thread-default main loop of the thread
+ * that you call this constructor from.
  *
- * Returns: A new #GUdevClient object. Free with g_object_unref().
+ * @return A new #GUdevClient object. Free with g_object_unref().
  */
 GUdevClient *
 g_udev_client_new (const gchar * const *subsystems)
 }
 
 /**
- * g_udev_client_query_by_subsystem:
- * @client: A #GUdevClient.
- * @subsystem: (allow-none): The subsystem to get devices for or %NULL to get all devices.
+ * @param client A #GUdevClient.
+ * @param subsystem (allow-none) The subsystem to get devices for or %NULL to get all devices.
  *
- * Gets all devices belonging to @subsystem.
+ * Gets all devices belonging to subsystem.
  *
- * Returns: (element-type GUdevDevice) (transfer full): A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list.
+ * @return (element-type GUdevDevice) (transfer full) A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list.
  */
 GList *
 g_udev_client_query_by_subsystem (GUdevClient  *client,
 }
 
 /**
- * g_udev_client_query_by_device_number:
- * @client: A #GUdevClient.
- * @type: A value from the #GUdevDeviceType enumeration.
- * @number: A device number.
+ * @param client A #GUdevClient.
+ * @param type A value from the #GUdevDeviceType enumeration.
+ * @param number A device number.
  *
  * Looks up a device for a type and device number.
  *
- * Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_client_query_by_device_number (GUdevClient      *client,
 }
 
 /**
- * g_udev_client_query_by_device_file:
- * @client: A #GUdevClient.
- * @device_file: A device file.
+ * @param client A #GUdevClient.
+ * @param device_file A device file.
  *
  * Looks up a device for a device file.
  *
- * Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_client_query_by_device_file (GUdevClient  *client,
 }
 
 /**
- * g_udev_client_query_by_sysfs_path:
- * @client: A #GUdevClient.
- * @sysfs_path: A sysfs path.
+ * @param client A #GUdevClient.
+ * @param sysfs_path A sysfs path.
  *
  * Looks up a device for a sysfs path.
  *
- * Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_client_query_by_sysfs_path (GUdevClient  *client,
 }
 
 /**
- * g_udev_client_query_by_subsystem_and_name:
- * @client: A #GUdevClient.
- * @subsystem: A subsystem name.
- * @name: The name of the device.
+ * @param client A #GUdevClient.
+ * @param subsystem A subsystem name.
+ * @param name The name of the device.
  *
  * Looks up a device for a subsystem and name.
  *
- * Returns: (transfer full): A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice object or %NULL if the device was not found. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_client_query_by_subsystem_and_name (GUdevClient  *client,
   g_return_val_if_fail (G_UDEV_IS_CLIENT (client), NULL);
   return client->priv->udev;
 }
+
+/* @} -- gudevclient group */

src/gudev/gudevdevice.c

+/** @file gudevdevice.c */
+
 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
  *
  * Copyright (C) 2008 David Zeuthen <davidz@redhat.com>
 #include "gudevprivate.h"
 
 /**
- * SECTION:gudevdevice
- * @short_description: Get information about a device
+ * @defgroup gudev GUdev
+ */
+
+/**
+ * @defgroup gudevdevice GUdevDevice
+ * @ingroup gudev
+ * @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
  * #GUdevDevice whenever an event happens.
  */
 
+/* @{ -- gudevdevice group */
+
 struct _GUdevDevicePrivate
 {
   struct udev_device *udevice;
 }
 
 /**
- * g_udev_device_get_subsystem:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the subsystem for @device.
+ * Gets the subsystem for device.
  *
- * Returns: The subsystem for @device.
+ * @return The subsystem for device.
  */
 const gchar *
 g_udev_device_get_subsystem (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_devtype:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the device type for @device.
+ * Gets the device type for device.
  *
- * Returns: The devtype for @device.
+ * @return The devtype for device.
  */
 const gchar *
 g_udev_device_get_devtype (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_name:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the name of @device, e.g. "sda3".
+ * Gets the name of device, e.g. "sda3".
  *
- * Returns: The name of @device.
+ * @return The name of device.
  */
 const gchar *
 g_udev_device_get_name (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_number:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the number of @device, e.g. "3" if g_udev_device_get_name() returns "sda3".
+ * Gets the number of device, e.g. "3" if g_udev_device_get_name() returns "sda3".
  *
- * Returns: The number of @device.
+ * @return The number of device.
  */
 const gchar *
 g_udev_device_get_number (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_sysfs_path:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the sysfs path for @device.
+ * Gets the sysfs path for device.
  *
- * Returns: The sysfs path for @device.
+ * @return The sysfs path for device.
  */
 const gchar *
 g_udev_device_get_sysfs_path (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_driver:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the name of the driver used for @device.
+ * Gets the name of the driver used for device.
  *
- * Returns: The name of the driver for @device or %NULL if unknown.
+ * @return The name of the driver for device or %NULL if unknown.
  */
 const gchar *
 g_udev_device_get_driver (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_action:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the most recent action (e.g. "add", "remove", "change", etc.) for @device.
+ * Gets the most recent action (e.g. "add", "remove", "change", etc.) for device.
  *
- * Returns: An action string.
+ * @return An action string.
  */
 const gchar *
 g_udev_device_get_action (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_seqnum:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the most recent sequence number for @device.
+ * Gets the most recent sequence number for device.
  *
- * Returns: A sequence number.
+ * @return A sequence number.
  */
 guint64
 g_udev_device_get_seqnum (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_device_type:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the type of the device file, if any, for @device.
+ * Gets the type of the device file, if any, for device.
  *
- * Returns: The device number for @device or #G_UDEV_DEVICE_TYPE_NONE if the device does not have a device file.
+ * @return The device number for device or #G_UDEV_DEVICE_TYPE_NONE if the device does not have a device file.
  */
 GUdevDeviceType
 g_udev_device_get_device_type (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_device_number:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the device number, if any, for @device.
+ * Gets the device number, if any, for device.
  *
- * Returns: The device number for @device or 0 if unknown.
+ * @return The device number for device or 0 if unknown.
  */
 GUdevDeviceNumber
 g_udev_device_get_device_number (GUdevDevice *device)
 }
 
 /**
- * g_udev_device_get_device_file:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the device file for @device.
+ * Gets the device file for device.
  *
- * Returns: The device file for @device or %NULL if no device file
+ * @return The device file for device or %NULL if no device file
  * exists.
  */
 const gchar *
 }
 
 /**
- * g_udev_device_get_device_file_symlinks:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets a list of symlinks (in <literal>/dev</literal>) that points to
- * the device file for @device.
+ * Gets a list of symlinks (in /dev) that points to the device file for device.
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): A %NULL terminated string array of symlinks. This array is owned by @device and should not be freed by the caller.
+ * @return (transfer none) (array zero-terminated=1) (element-type utf8) A %NULL terminated string array of symlinks. This array is owned by device and should not be freed by the caller.
  */
 const gchar * const *
 g_udev_device_get_device_file_symlinks (GUdevDevice *device)
 /* ---------------------------------------------------------------------------------------------------- */
 
 /**
- * g_udev_device_get_parent:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets the immediate parent of @device, if any.
+ * Gets the immediate parent of device, if any.
  *
- * Returns: (transfer full): A #GUdevDevice or %NULL if @device has no parent. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice or %NULL if device has no parent. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_device_get_parent (GUdevDevice  *device)
 }
 
 /**
- * g_udev_device_get_parent_with_subsystem:
- * @device: A #GUdevDevice.
- * @subsystem: The subsystem of the parent to get.
- * @devtype: (allow-none): The devtype of the parent to get or %NULL.
+ * @param device A #GUdevDevice.
+ * @param subsystem The subsystem of the parent to get.
+ * @param devtype (allow-none) The devtype of the parent to get or %NULL.
  *
- * Walks up the chain of parents of @device and returns the first
- * device encountered where @subsystem and @devtype matches, if any.
+ * Walks up the chain of parents of device and returns the first
+ * device encountered where subsystem and devtype matches, if any.
  *
- * Returns: (transfer full): A #GUdevDevice or %NULL if @device has no parent with @subsystem and @devtype. Free with g_object_unref().
+ * @return (transfer full) A #GUdevDevice or %NULL if device has no parent with subsystem and @devtype. Free with g_object_unref().
  */
 GUdevDevice *
 g_udev_device_get_parent_with_subsystem (GUdevDevice  *device,
 /* ---------------------------------------------------------------------------------------------------- */
 
 /**
- * g_udev_device_get_property_keys:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets all keys for properties on @device.
+ * Gets all keys for properties on device.
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): A %NULL terminated string array of property keys. This array is owned by @device and should not be freed by the caller.
+ * @return (transfer none) (array zero-terminated=1) (element-type utf8) A %NULL terminated string array of property keys. This array is owned by device and should not be freed by the caller.
  */
 const gchar* const *
 g_udev_device_get_property_keys (GUdevDevice *device)
 
 
 /**
- * g_udev_device_has_property:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
  * Check if a the property with the given key exists.
  *
- * Returns: %TRUE only if the value for @key exist.
+ * @return %TRUE only if the value for key exist.
  */
 gboolean
 g_udev_device_has_property (GUdevDevice  *device,
 }
 
 /**
- * g_udev_device_get_property:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device.
+ * Look up the value for key on device.
  *
- * Returns: The value for @key or %NULL if @key doesn't exist on @device. Do not free this string, it is owned by @device.
+ * @return The value for key or %NULL if key doesn't exist on device. Do not free this string, it is owned by device.
  */
 const gchar *
 g_udev_device_get_property (GUdevDevice  *device,
 }
 
 /**
- * g_udev_device_get_property_as_int:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device and convert it to an integer
+ * Look up the value for key on device and convert it to an integer
  * using strtol().
  *
- * Returns: The value for @key or 0 if @key doesn't exist or
+ * @return The value for key or 0 if key doesn't exist or
  * isn't an integer.
  */
 gint
 }
 
 /**
- * g_udev_device_get_property_as_uint64:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device and convert it to an unsigned
+ * Look up the value for key on device and convert it to an unsigned
  * 64-bit integer using g_ascii_strtoull().
  *
- * Returns: The value  for @key or 0 if @key doesn't  exist or isn't a
+ * @return The value  for key or 0 if key doesn't  exist or isn't a
  * #guint64.
  */
 guint64
 }
 
 /**
- * g_udev_device_get_property_as_double:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device and convert it to a double
+ * Look up the value for key on device and convert it to a double
  * precision floating point number using strtod().
  *
- * Returns: The value for @key or 0.0 if @key doesn't exist or isn't a
+ * @return The value for key or 0.0 if key doesn't exist or isn't a
  * #gdouble.
  */
 gdouble
 }
 
 /**
- * g_udev_device_get_property_as_boolean:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device and convert it to an
+ * Look up the value for key on device and convert it to an
  * boolean. This is done by doing a case-insensitive string comparison
  * on the string value against "1" and "true".
  *
- * Returns: The value for @key or %FALSE if @key doesn't exist or
+ * @return The value for key or %FALSE if key doesn't exist or
  * isn't a #gboolean.
  */
 gboolean
 }
 
 /**
- * g_udev_device_get_property_as_strv:
- * @device: A #GUdevDevice.
- * @key: Name of property.
+ * @param device A #GUdevDevice.
+ * @param key Name of property.
  *
- * Look up the value for @key on @device and return the result of
+ * Look up the value for key on device and return the result of
  * splitting it into non-empty tokens split at white space (only space
  * (' '), form-feed ('\f'), newline ('\n'), carriage return ('\r'),
  * horizontal tab ('\t'), and vertical tab ('\v') are considered; the
  * locale is not taken into account).
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): The value of @key on @device split into tokens or %NULL if @key doesn't exist. This array is owned by @device and should not be freed by the caller.
+ * @return (transfer none) (array zero-terminated=1) (element-type utf8) The value of key on device split into tokens or %NULL if key doesn't exist. This array is owned by device and should not be freed by the caller.
  */
 const gchar* const *
 g_udev_device_get_property_as_strv (GUdevDevice  *device,
 /* ---------------------------------------------------------------------------------------------------- */
 
 /**
- * g_udev_device_get_sysfs_attr:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device.
+ * Look up the sysfs attribute with name on device.
  *
- * Returns: The value of the sysfs attribute or %NULL if there is no
- * such attribute. Do not free this string, it is owned by @device.
+ * @return The value of the sysfs attribute or %NULL if there is no
+ * such attribute. Do not free this string, it is owned by device.
  */
 const gchar *
 g_udev_device_get_sysfs_attr (GUdevDevice  *device,
 }
 
 /**
- * g_udev_device_get_sysfs_attr_as_int:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device and convert it to an integer
+ * Look up the sysfs attribute with name on device and convert it to an integer
  * using strtol().
  *
- * Returns: The value of the sysfs attribute or 0 if there is no such
+ * @return The value of the sysfs attribute or 0 if there is no such
  * attribute.
  */
 gint
 }
 
 /**
- * g_udev_device_get_sysfs_attr_as_uint64:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device and convert it to an unsigned
+ * Look up the sysfs attribute with name on device and convert it to an unsigned
  * 64-bit integer using g_ascii_strtoull().
  *
- * Returns: The value of the sysfs attribute or 0 if there is no such
+ * @return The value of the sysfs attribute or 0 if there is no such
  * attribute.
  */
 guint64
 }
 
 /**
- * g_udev_device_get_sysfs_attr_as_double:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device and convert it to a double
+ * Look up the sysfs attribute with name on device and convert it to a double
  * precision floating point number using strtod().
  *
- * Returns: The value of the sysfs attribute or 0.0 if there is no such
+ * @return The value of the sysfs attribute or 0.0 if there is no such
  * attribute.
  */
 gdouble
 }
 
 /**
- * g_udev_device_get_sysfs_attr_as_boolean:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device and convert it to an
+ * Look up the sysfs attribute with name on device and convert it to an
  * boolean. This is done by doing a case-insensitive string comparison
  * on the string value against "1" and "true".
  *
- * Returns: The value of the sysfs attribute or %FALSE if there is no such
+ * @return The value of the sysfs attribute or %FALSE if there is no such
  * attribute.
  */
 gboolean
 }
 
 /**
- * g_udev_device_get_sysfs_attr_as_strv:
- * @device: A #GUdevDevice.
- * @name: Name of the sysfs attribute.
+ * @param device A #GUdevDevice.
+ * @param name Name of the sysfs attribute.
  *
- * Look up the sysfs attribute with @name on @device and return the result of
+ * Look up the sysfs attribute with name on device and return the result of
  * splitting it into non-empty tokens split at white space (only space (' '),
  * form-feed ('\f'), newline ('\n'), carriage return ('\r'), horizontal
  * tab ('\t'), and vertical tab ('\v') are considered; the locale is
  * not taken into account).
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): The value of the sysfs attribute split into tokens or %NULL if there is no such attribute. This array is owned by @device and should not be freed by the caller.
+ * @return (transfer none) (array zero-terminated=1) (element-type utf8) The value of the sysfs attribute split into tokens or %NULL if there is no such attribute. This array is owned by device and should not be freed by the caller.
  */
 const gchar * const *
 g_udev_device_get_sysfs_attr_as_strv (GUdevDevice  *device,
 }
 
 /**
- * g_udev_device_get_tags:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets all tags for @device.
+ * Gets all tags for device.
  *
- * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): A %NULL terminated string array of tags. This array is owned by @device and should not be freed by the caller.
+ * @return (transfer none) (array zero-terminated=1) (element-type utf8) A %NULL terminated string array of tags. This array is owned by device and should not be freed by the caller.
  *
- * Since: 165
+ * @since 165
  */
 const gchar* const *
 g_udev_device_get_tags (GUdevDevice  *device)
 }
 
 /**
- * g_udev_device_get_is_initialized:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets whether @device has been initalized.
+ * Gets whether device has been initalized.
  *
- * Returns: Whether @device has been initialized.
+ * @return Whether device has been initialized.
  *
- * Since: 165
+ * @since 165
  */
 gboolean
 g_udev_device_get_is_initialized (GUdevDevice  *device)
 }
 
 /**
- * g_udev_device_get_usec_since_initialized:
- * @device: A #GUdevDevice.
+ * @param device A #GUdevDevice.
  *
- * Gets number of micro-seconds since @device was initialized.
+ * Gets number of micro-seconds since device was initialized.
  *
  * This only works for devices with properties in the udev
  * database. All other devices return 0.
  *
- * Returns: Number of micro-seconds since @device was initialized or 0 if unknown.
+ * @return Number of micro-seconds since device was initialized or 0 if unknown.
  *
- * Since: 165
+ * @since 165
  */
 guint64
 g_udev_device_get_usec_since_initialized (GUdevDevice *device)
   g_return_val_if_fail (G_UDEV_IS_DEVICE (device), 0);
   return udev_device_get_usec_since_initialized (device->priv->udevice);
 }
+
+/* @} -- gudevdevice group */

src/gudev/gudevenumerator.c

+/** @file gudevenumerator.c */
+
 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
  *
  * Copyright (C) 2008-2010 David Zeuthen <davidz@redhat.com>
 #include "gudevprivate.h"
 
 /**
- * SECTION:gudevenumerator
- * @short_description: Lookup and sort devices
+ * @defgroup gudevenumerator GUdevEnumerator
+ * @ingroup gudev
+ * @brief Lookup and sort devices
  *
  * #GUdevEnumerator is used to lookup and sort devices.
  *
- * Since: 165
+ * @since 165
  */
 
+/* @{ -- gudevenumerator group */
+
 struct _GUdevEnumeratorPrivate
 {
   GUdevClient *client;
   gobject_class->constructed  = g_udev_enumerator_constructed;
 
   /**
-   * GUdevEnumerator:client:
-   *
    * The #GUdevClient to enumerate devices from.
    *
-   * Since: 165
+   * @since 165
    */
   g_object_class_install_property (gobject_class,
                                    PROP_CLIENT,
 }
 
 /**
- * g_udev_enumerator_new:
- * @client: A #GUdevClient to enumerate devices from.
+ * @param client A #GUdevClient to enumerate devices from.
  *
  * Constructs a #GUdevEnumerator object that can be used to enumerate
  * and sort devices. Use the add_match_*() and add_nomatch_*() methods
  * and execute the query to get a list of devices with
  * g_udev_enumerator_execute().
  *
- * Returns: A new #GUdevEnumerator object. Free with g_object_unref().
+ * @return A new #GUdevEnumerator object. Free with g_object_unref().
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_new (GUdevClient *client)
 
 
 /**
- * g_udev_enumerator_add_match_subsystem:
- * @enumerator: A #GUdevEnumerator.
- * @subsystem: Wildcard for subsystem name e.g. 'scsi' or 'a*'.
+ * @param enumerator A #GUdevEnumerator.
+ * @param subsystem Wildcard for subsystem name e.g. 'scsi' or 'a*'.
  *
- * All returned devices will match the given @subsystem.
+ * All returned devices will match the given subsystem.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_subsystem (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_nomatch_subsystem:
- * @enumerator: A #GUdevEnumerator.
- * @subsystem: Wildcard for subsystem name e.g. 'scsi' or 'a*'.
+ * @param enumerator A #GUdevEnumerator.
+ * @param subsystem Wildcard for subsystem name e.g. 'scsi' or 'a*'.
  *
- * All returned devices will not match the given @subsystem.
+ * All returned devices will not match the given subsystem.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_nomatch_subsystem (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_match_sysfs_attr:
- * @enumerator: A #GUdevEnumerator.
- * @name: Wildcard filter for sysfs attribute key.
- * @value: Wildcard filter for sysfs attribute value.
+ * @param enumerator A #GUdevEnumerator.
+ * @param name Wildcard filter for sysfs attribute key.
+ * @param value Wildcard filter for sysfs attribute value.
  *
- * All returned devices will have a sysfs attribute matching the given @name and @value.
+ * All returned devices will have a sysfs attribute matching the given name and value.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_sysfs_attr (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_nomatch_sysfs_attr:
- * @enumerator: A #GUdevEnumerator.
- * @name: Wildcard filter for sysfs attribute key.
- * @value: Wildcard filter for sysfs attribute value.
+ * @param enumerator A #GUdevEnumerator.
+ * @param name Wildcard filter for sysfs attribute key.
+ * @param value Wildcard filter for sysfs attribute value.
  *
- * All returned devices will not have a sysfs attribute matching the given @name and @value.
+ * All returned devices will not have a sysfs attribute matching the given name and value.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_nomatch_sysfs_attr (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_match_property:
- * @enumerator: A #GUdevEnumerator.
- * @name: Wildcard filter for property name.
- * @value: Wildcard filter for property value.
+ * @param enumerator A #GUdevEnumerator.
+ * @param name Wildcard filter for property name.
+ * @param value Wildcard filter for property value.
  *
- * All returned devices will have a property matching the given @name and @value.
+ * All returned devices will have a property matching the given name and value.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_property (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_match_name:
- * @enumerator: A #GUdevEnumerator.
- * @name: Wildcard filter for kernel name e.g. "sda*".
+ * @param enumerator A #GUdevEnumerator.
+ * @param name Wildcard filter for kernel name e.g. "sda*".
  *
- * All returned devices will match the given @name.
+ * All returned devices will match the given name.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_name (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_sysfs_path:
- * @enumerator: A #GUdevEnumerator.
- * @sysfs_path: A sysfs path, e.g. "/sys/devices/pci0000:00/0000:00:1f.2/host0/target0:0:0/0:0:0:0/block/sda"
+ * @param enumerator A #GUdevEnumerator.
+ * @param sysfs_path: A sysfs path, e.g. "/sys/devices/pci0000:00/0000:00:1f.2/host0/target0:0:0/0:0:00/block/sda"
  *
  * Add a device to the list of devices, to retrieve it back sorted in dependency order.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_sysfs_path (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_match_tag:
- * @enumerator: A #GUdevEnumerator.
- * @tag: A udev tag e.g. "udev-acl".
+ * @param enumerator A #GUdevEnumerator.
+ * @param tag A udev tag e.g. "udev-acl".
  *
- * All returned devices will match the given @tag.
+ * All returned devices will match the given tag.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_tag (GUdevEnumerator  *enumerator,
 }
 
 /**
- * g_udev_enumerator_add_match_is_initialized:
- * @enumerator: A #GUdevEnumerator.
+ * @param enumerator A #GUdevEnumerator.
  *
  * All returned devices will be initialized.
  *
- * Returns: (transfer none): The passed in @enumerator.
+ * @return (transfer none) The passed in enumerator.
  *
- * Since: 165
+ * @since 165
  */
 GUdevEnumerator *
 g_udev_enumerator_add_match_is_initialized (GUdevEnumerator  *enumerator)
 }
 
 /**
- * g_udev_enumerator_execute:
- * @enumerator: A #GUdevEnumerator.
+ * @param enumerator A #GUdevEnumerator.
  *
- * Executes the query in @enumerator.
+ * Executes the query in enumerator.
  *
- * Returns: (element-type GUdevDevice) (transfer full): A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list.
+ * @return (element-type GUdevDevice) (transfer full) A list of #GUdevDevice objects. The caller should free the result by using g_object_unref() on each element in the list and then g_list_free() on the list.
  *
- * Since: 165
+ * @since 165
  */
 GList *
 g_udev_enumerator_execute (GUdevEnumerator  *enumerator)
 
   return ret;
 }
+
+/* @} -- gudevenumerator group */
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.