From: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Date: Fri, 5 Jun 2020 14:41:57 +0000 (+0900)
Subject: hwdep: fulfill documentation for ALSAHwdep
X-Git-Tag: v0.1.0~141
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=eb03ec0340bc19736017a9258925a54c70e7e02f;p=alsa-gobject.git

hwdep: fulfill documentation for ALSAHwdep

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
---

diff --git a/doc/reference/hwdep/alsahwdep-docs.xml b/doc/reference/hwdep/alsahwdep-docs.xml
index ea2d167..7de0ce7 100644
--- a/doc/reference/hwdep/alsahwdep-docs.xml
+++ b/doc/reference/hwdep/alsahwdep-docs.xml
@@ -12,6 +12,16 @@
     </releaseinfo>
     </bookinfo>
 
+    <chapter id="introduction">
+        <title></title>
+        <param>This library is designed for applications to manipulate ALSA
+        hwdep character device and retrieve common information of hardware
+        dependent functionality abstracted as hwdep device. As the design
+        concept means; hardware dependent, this library has no further
+        functionality. Each applications should implement it by their own.
+        </param>
+    </chapter>
+
     <chapter id="alsahwdep-enumerations">
         <title>ALSAHwdep enumerations</title>
         <xi:include href="xml/alsahwdep-enum-types.xml"/>
diff --git a/src/hwdep/device-info.c b/src/hwdep/device-info.c
index 44ff77e..cbe019f 100644
--- a/src/hwdep/device-info.c
+++ b/src/hwdep/device-info.c
@@ -1,6 +1,18 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 #include "privates.h"
 
+/**
+ * SECTION: device-info
+ * @Title: ALSAHwdepDeviceInfo
+ * @Short_description: A GObject-derived object to represent information of
+ *                     ALSA hwdep device.
+ *
+ * A #ALSAHwdepDeviceInfo is a GObject-derived object to represent information
+ * of ALSA hwdep device. The call of alsahwdep_get_device_info() returns an
+ * instance of the object.
+ *
+ * The object wraps 'struct snd_hwdep_info' in UAPI of Linux sound subsystem.
+ */
 struct _ALSAHwdepDeviceInfoPrivate {
     struct snd_hwdep_info info;
 };
diff --git a/src/hwdep/query.c b/src/hwdep/query.c
index 5f92f0f..5a615b1 100644
--- a/src/hwdep/query.c
+++ b/src/hwdep/query.c
@@ -12,6 +12,13 @@
 
 #include <libudev.h>
 
+/**
+ * SECTION: query
+ * @Title: Global functions in ALSAHwdep
+ * @Short_description: Global functions available without holding any file
+ *                     descriptor
+ */
+
 // For error handling.
 G_DEFINE_QUARK("alsahwdep-error", alsahwdep_error)