doc bug

[Florian Bomers <Florian.Bomers@sun.com>]

in alsa-lib/src/pcm/pcm_misc.c:654 function snd_pcm_build_linear_format, the
documentation is:

/**
 * \brief Compose a PCM sample linear format
 * \param width Nominal bits per sample
 * \param pwidth Physical bit width of the format
 * \param unsignd Sign: 0 signed, 1 unsigned
 * \return big_endian Endian: 0 little endian, 1 big endian
 */

but should be something like:

/**
 * \brief Compose a PCM sample linear format
 * \param width Nominal bits per sample
 * \param pwidth Physical bit width of the format
 * \param unsignd Sign: 0 signed, 1 unsigned
 * \param big_endian Endian: 0 little endian, 1 big endian
 * \return format the constructed format or SND_PCM_FORMAT_UNKNOWN on error
 */

The same (last param description given as return description) applies to some
other functions in pcm_misc.c 

Florian


-- 
Florian Bomers
Java Sound
Java Software/Sun Microsystems, Inc.
http://java.sun.com/products/java-media/sound/


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf