diff options
| author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-04-19 09:26:28 +0900 |
|---|---|---|
| committer | 坂本 貴史 <o-takashi@sakamocchi.jp> | 2022-04-19 09:29:46 +0900 |
| commit | c10207b734422b47d906336bb4ea02b004684d06 (patch) | |
| tree | c51e26686ac5cc652c51cfca906598a7ba6e85f8 | |
| parent | a9466a1eacec4ce9fd020b9bed56cc27059a5e57 (diff) | |
| download | libhinawa-c10207b734422b47d906336bb4ea02b004684d06.tar.gz | |
snd_dg00x: link optimization to gi-docgen
The gi-docgen supports enhancement of inter-document link. This commit is
optimization to it.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
| -rw-r--r-- | src/snd_dg00x.c | 26 | ||||
| -rw-r--r-- | src/snd_dg00x.h | 5 |
2 files changed, 13 insertions, 18 deletions
diff --git a/src/snd_dg00x.c b/src/snd_dg00x.c index abbe098..e0de7a6 100644 --- a/src/snd_dg00x.c +++ b/src/snd_dg00x.c @@ -5,13 +5,10 @@ #include <errno.h> /** - * SECTION:snd_dg00x - * @Title: HinawaSndDg00x - * @Short_description: A notification listener for Dg00x models - * @include: snd_dg00x.h + * HinawaSndDg00x: + * A notification listener for Digidesign Digi 00x models. * - * A #HinawaSndDg00x listen to Dg00x notification and generates signal when - * received. This inherits #HinawaSndUnit. + * A [class@SndDg00x] listen to Dg00x notification and generates signal when received. */ G_DEFINE_TYPE(HinawaSndDg00x, hinawa_snd_dg00x, HINAWA_TYPE_SND_UNIT) @@ -27,11 +24,10 @@ static void hinawa_snd_dg00x_class_init(HinawaSndDg00xClass *klass) { /** * HinawaSndDg00x::message: - * @self: A #HinawaSndDg00x + * @self: A [class@SndDg00x] * @message: A message * - * When Dg00x models transfer notification, the #HinawaSndDg00x::message signal is - * generated. + * Emitted when Dg00x models transfer notification. * * Since: 0.7 */ @@ -53,9 +49,9 @@ static void hinawa_snd_dg00x_init(HinawaSndDg00x *self) /** * hinawa_snd_dg00x_new: * - * Instantiate #HinawaSndDg00x object and return the instance. + * Instantiate [class@SndDg00x] object and return the instance. * - * Returns: an instance of #HinawaSndDg00x. + * Returns: an instance of [class@SndDg00x]. * Since: 1.3. */ HinawaSndDg00x *hinawa_snd_dg00x_new(void) @@ -65,12 +61,12 @@ HinawaSndDg00x *hinawa_snd_dg00x_new(void) /** * hinawa_snd_dg00x_open: - * @self: A #HinawaSndUnit + * @self: A [class@SndDg00x] * @path: A full path of a special file for ALSA hwdep character device - * @error: A #GError. Error can be generated with three domains; #g_file_error_quark(), - * #hinawa_fw_node_error_quark(), and #hinawa_snd_unit_error_quark(). + * @error: A [struct@GLib.Error]. Error can be generated with three domains; GLib.FileError, + * Hinawa.FwNodeError, and Hinawa.SndUnitError. * - * Open ALSA hwdep character device and check it for Dg00x devices. + * Open ALSA hwdep character device and check it for Dg00x devices. * * Since: 0.7 */ diff --git a/src/snd_dg00x.h b/src/snd_dg00x.h index ba660f7..a701b47 100644 --- a/src/snd_dg00x.h +++ b/src/snd_dg00x.h @@ -15,11 +15,10 @@ struct _HinawaSndDg00xClass { /** * HinawaSndDg00xClass::message: - * @self: A #HinawaSndDg00x + * @self: A [class@SndDg00x] * @message: A message * - * When Dg00x models transfer notification, the #HinawaSndDg00xClass::message handler is - * called. + * Class closure for the [signal@SndDg00x::message] signal. * * Since: 1.2 */ |