diff options
author | Takashi Iwai <tiwai@suse.de> | 2012-09-13 08:38:59 +0200 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2012-09-13 08:38:59 +0200 |
commit | 63f6f4a6103e55d242440488999e648beb5e4e4d (patch) | |
tree | f1a0e95212d1cba69ddb6754a320a72dd75d931a /include/pcm.h | |
parent | c6db60e32758e8f4bb6f066a5c6fc7758a0f4c49 (diff) |
PCM: A few doxygen fixes for chmap stuff
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'include/pcm.h')
-rw-r--r-- | include/pcm.h | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/include/pcm.h b/include/pcm.h index 5fb6130f..290593b9 100644 --- a/include/pcm.h +++ b/include/pcm.h @@ -519,20 +519,24 @@ enum snd_pcm_chmap_position { SND_CHMAP_LAST = SND_CHMAP_TRC, /** last entry */ }; -#define SND_CHMAP_POSITION_MASK 0xffff /** bitmask for channel position */ -#define SND_CHMAP_PHASE_INVERSE (0x01 << 16) /* the channel is phase inverted */ -#define SND_CHMAP_DRIVER_SPEC (0x02 << 16) /* non-standard channel value */ +/** bitmask for channel position */ +#define SND_CHMAP_POSITION_MASK 0xffff + +/** bit flag indicating the channel is phase inverted */ +#define SND_CHMAP_PHASE_INVERSE (0x01 << 16) +/** bit flag indicating the non-standard channel value */ +#define SND_CHMAP_DRIVER_SPEC (0x02 << 16) /** the channel map header */ typedef struct snd_pcm_chmap { - unsigned int channels; - unsigned int pos[0]; + unsigned int channels; /** number of channels */ + unsigned int pos[0]; /** channel position array */ } snd_pcm_chmap_t; /** the header of array items returned from snd_pcm_query_chmaps() */ typedef struct snd_pcm_chmap_query { - enum snd_pcm_chmap_type type; - snd_pcm_chmap_t map; + enum snd_pcm_chmap_type type; /** channel map type */ + snd_pcm_chmap_t map; /** available channel map */ } snd_pcm_chmap_query_t; |