[alsa-lib PATCH 1/4] Remove docs for snd_names_list and snd_names_list_free

[alsa-lib PATCH 1/4] Remove docs for snd_names_list and snd_names_list_free

[Andrew Eikum]

[-- Attachment #1: Type: text/plain, Size: 257 bytes --]


No need to have misleading docs for functions that do nothing.
---

Resending the whole sequence. New patch 4/4 improves the documentation
for the name hints functions.

 src/names.c |   13 ++-----------
 1 files changed, 2 insertions(+), 11 deletions(-)


[-- Attachment #2: 0001-Remove-docs-for-snd_names_list-and-snd_names_list_fr.patch --]
[-- Type: text/x-patch, Size: 1242 bytes --]

diff --git a/src/names.c b/src/names.c
index e7a6887..000e574 100644
--- a/src/names.c
+++ b/src/names.c
@@ -36,14 +36,8 @@
 #include "local.h"
 
 /** 
- * \brief Give a list of device names and associated comments for selected interface
- * \param iface a string identifying interface ("pcm", "ctl", "seq", "rawmidi")
- * \param list result - a pointer to list
- * \return A non-negative value if successful, otherwise a negative error code.
+ * \brief This function is unimplemented.
  * \deprecated Since 1.0.14
- *
- * The global configuration files are specified in the environment variable
- * \c ALSA_NAMES_FILE.
  */
 int snd_names_list(const char *iface ATTRIBUTE_UNUSED,
 		   snd_devname_t **list ATTRIBUTE_UNUSED)
@@ -53,11 +47,8 @@ int snd_names_list(const char *iface ATTRIBUTE_UNUSED,
 link_warning(snd_names_list, "Warning: snd_names_list is deprecated, use snd_device_name_hint");
 
 /**
- * \brief Release the list of device names
- * \param list the name list to release
+ * \brief This function is unimplemented.
  * \deprecated Since 1.0.14
- *
- * Releases the list of device names allocated via #snd_names_list().
  */
 void snd_names_list_free(snd_devname_t *list ATTRIBUTE_UNUSED)
 {

[-- Attachment #3: Type: text/plain, Size: 0 bytes --]