pcm: snd_pcm_(physical_)format_width() - change documentation

The word "nominal" is not so correct here. Use similar wording as we use in the kernel space (the bit-width of the format). Link: larsimmisch/pyalsaaudio#146 Signed-off-by: Jaroslav Kysela <[email protected]>
alsa-project · Feb 22, 2024 · 19be3b2 · 19be3b2
1 parent d8ce72f
commit 19be3b2
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/pcm/pcm_misc.c b/src/pcm/pcm_misc.c
@@ -203,9 +203,9 @@ int snd_pcm_format_cpu_endian(snd_pcm_format_t format)
 }
 
 /**
- * \brief Return nominal bits per a PCM sample
+ * \brief Return the bit-width of the format
  * \param format Sample format
- * \return bits per sample, a negative error code if not applicable
+ * \return the bit-width of the format, or a negative error code if not applicable
  */
 int snd_pcm_format_width(snd_pcm_format_t format)
 {
@@ -270,9 +270,9 @@ int snd_pcm_format_width(snd_pcm_format_t format)
 }
 
 /**
- * \brief Return bits needed to store a PCM sample
+ * \brief Return the physical bit-width of the format (bits needed to store a PCM sample)
  * \param format Sample format
- * \return bits per sample, a negative error code if not applicable
+ * \return the physical bit-width of the format, or a negative error code if not applicable
  */
 int snd_pcm_format_physical_width(snd_pcm_format_t format)
 {