Alsa-Devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [alsa-lib PATCH] Remove docs for snd_names_list and snd_names_list_free
@ 2011-11-02 17:40 Andrew Eikum
  0 siblings, 0 replies; only message in thread
From: Andrew Eikum @ 2011-11-02 17:40 UTC (permalink / raw)
  To: alsa-devel, Jaroslav Kysela

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


"Deprecated," to me, doesn't necessarily imply "completely useless,"
especially if there are complete docs attached. To prevent future
confusion, make it clear that these functions are now unimplemented.

---
 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 --]



^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2011-11-02 17:40 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-11-02 17:40 [alsa-lib PATCH] Remove docs for snd_names_list and snd_names_list_free Andrew Eikum

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox