From: borine <32966433+borine@users.noreply.github.com>
Date: Sun, 30 Jul 2023 09:58:23 +0000 (+0100)
Subject: doxygen: namehint: silence 'not documented' warnings
X-Git-Tag: v1.2.10~13
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=382c700dfece324128d7a60ae0cdf07f3e250e90;p=alsa-lib.git

doxygen: namehint: silence 'not documented' warnings

Also creates a new module within the Configuration interface
documentation in which to present the name hint docs.

From: borine@github
Link: https://github.com/alsa-project/alsa-lib/pull/340
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in
index 0604c8b2..d9292fa8 100644
--- a/doc/doxygen.cfg.in
+++ b/doc/doxygen.cfg.in
@@ -50,6 +50,7 @@ INPUT            = @top_srcdir@/doc/index.doxygen \
 		   @top_srcdir@/src/control/control_shm.c \
 		   @top_srcdir@/src/control/ctlparse.c \
 		   @top_srcdir@/src/control/hcontrol.c \
+		   @top_srcdir@/src/control/namehint.c \
 		   @top_srcdir@/src/control/setup.c \
 		   @top_srcdir@/src/control/tlv.c \
 		   @top_srcdir@/src/mixer \
diff --git a/include/control.h b/include/control.h
index 41892de2..ab482ba4 100644
--- a/include/control.h
+++ b/include/control.h
@@ -374,10 +374,6 @@ int snd_card_get_index(const char *name);
 int snd_card_get_name(int card, char **name);
 int snd_card_get_longname(int card, char **name);
 
-int snd_device_name_hint(int card, const char *iface, void ***hints);
-int snd_device_name_free_hint(void **hints);
-char *snd_device_name_get_hint(const void *hint, const char *id);
-
 int snd_ctl_open(snd_ctl_t **ctl, const char *name, int mode);
 int snd_ctl_open_lconf(snd_ctl_t **ctl, const char *name, int mode, snd_config_t *lconf);
 int snd_ctl_open_fallback(snd_ctl_t **ctl, snd_config_t *root, const char *name, const char *orig_name, int mode);
@@ -797,6 +793,20 @@ int snd_sctl_remove(snd_sctl_t *handle);
 
 /** \} */
 
+/**
+ *  \defgroup Hint Name Hint Interface
+ *  \ingroup Configuration
+ *  The name hint interface - get descriptive information about a device
+ *  (name, description, input/output).
+ *  \{
+ */
+
+int snd_device_name_hint(int card, const char *iface, void ***hints);
+int snd_device_name_free_hint(void **hints);
+char *snd_device_name_get_hint(const void *hint, const char *id);
+
+/** \} */
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/src/control/namehint.c b/src/control/namehint.c
index 64ecafa5..11783c0c 100644
--- a/src/control/namehint.c
+++ b/src/control/namehint.c
@@ -1,5 +1,6 @@
 /**
  * \file control/namehint.c
+ * \ingroup Configuration
  * \brief Give device name hints
  * \author Jaroslav Kysela <perex@perex.cz>
  * \date 2006