All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andrew Eikum <aeikum@codeweavers.com>
To: alsa-devel <alsa-devel@alsa-project.org>
Subject: [alsa-lib PATCH 1/4] Remove docs for snd_names_list and snd_names_list_free
Date: Wed, 4 Jan 2012 14:11:27 -0600	[thread overview]
Message-ID: <20120104201127.GC9868@foghorn.codeweavers.com> (raw)

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



                 reply	other threads:[~2012-01-04 20:11 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20120104201127.GC9868@foghorn.codeweavers.com \
    --to=aeikum@codeweavers.com \
    --cc=alsa-devel@alsa-project.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.