From 23931800dad0cda0242179957a6f2915a4da2b5d Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Sat, 29 Jul 2023 16:01:33 +0100 Subject: [PATCH] doxygen: pcm: silence 'not documented' warnings From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela --- include/pcm.h | 20 ++++++++++---------- src/pcm/pcm.c | 6 +++--- src/pcm/pcm_meter.c | 2 ++ src/pcm/pcm_route.c | 2 ++ 4 files changed, 17 insertions(+), 13 deletions(-) diff --git a/include/pcm.h b/include/pcm.h index a29ea980..e7853313 100644 --- a/include/pcm.h +++ b/include/pcm.h @@ -343,6 +343,7 @@ typedef enum _snd_pcm_tstamp { SND_PCM_TSTAMP_LAST = SND_PCM_TSTAMP_ENABLE } snd_pcm_tstamp_t; +/** PCM timestamp type */ typedef enum _snd_pcm_tstamp_type { SND_PCM_TSTAMP_TYPE_GETTIMEOFDAY = 0, /**< gettimeofday equivalent */ SND_PCM_TSTAMP_TYPE_MONOTONIC, /**< posix_clock_monotonic equivalent */ @@ -350,6 +351,7 @@ typedef enum _snd_pcm_tstamp_type { SND_PCM_TSTAMP_TYPE_LAST = SND_PCM_TSTAMP_TYPE_MONOTONIC_RAW, } snd_pcm_tstamp_type_t; +/** PCM audio timestamp type */ typedef enum _snd_pcm_audio_tstamp_type { /** * first definition for backwards compatibility only, @@ -364,24 +366,22 @@ typedef enum _snd_pcm_audio_tstamp_type { SND_PCM_AUDIO_TSTAMP_TYPE_LAST = SND_PCM_AUDIO_TSTAMP_TYPE_LINK_SYNCHRONIZED } snd_pcm_audio_tstamp_type_t; +/** PCM audio timestamp config */ typedef struct _snd_pcm_audio_tstamp_config { /* 5 of max 16 bits used */ - unsigned int type_requested:4; - unsigned int report_delay:1; /* add total delay to A/D or D/A */ + unsigned int type_requested:4; /**< requested audio tstamp type */ + unsigned int report_delay:1; /**< add total delay to A/D or D/A */ } snd_pcm_audio_tstamp_config_t; +/** PCM audio timestamp report */ typedef struct _snd_pcm_audio_tstamp_report { /* 6 of max 16 bits used for bit-fields */ - /* for backwards compatibility */ - unsigned int valid:1; + unsigned int valid:1; /**< for backwards compatibility */ + unsigned int actual_type:4; /**< actual type if hardware could not support requested timestamp */ - /* actual type if hardware could not support requested timestamp */ - unsigned int actual_type:4; - - /* accuracy represented in ns units */ - unsigned int accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */ - unsigned int accuracy; /* up to 4.29s, will be packed in separate field */ + unsigned int accuracy_report:1; /**< 0 if accuracy unknown, 1 if accuracy field is valid */ + unsigned int accuracy; /**< up to 4.29s in ns units, will be packed in separate field */ } snd_pcm_audio_tstamp_report_t; /** Unsigned frames quantity */ diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c index 16cfe493..2077d6fa 100644 --- a/src/pcm/pcm.c +++ b/src/pcm/pcm.c @@ -3444,7 +3444,7 @@ int snd_pcm_areas_copy(const snd_pcm_channel_area_t *dst_areas, snd_pcm_uframes_ * \param dst_size size in frames of the destination buffer * \param src_channels source areas specification (one for each channel) * \param src_offset offset in frames inside source area - * \param dst_size size in frames of the source buffer + * \param src_size size in frames of the source buffer * \param channels channels count * \param frames frames to copy * \param format PCM sample format @@ -7022,7 +7022,7 @@ void snd_pcm_status_get_driver_htstamp(const snd_pcm_status_t *obj, snd_htimesta /** * \brief Get audio_tstamp_report from a PCM status container * \param obj pointer to #snd_pcm_status_t - * \param audio_tstamp_report Pointer to returned report (valid fields are accuracy and type) + * \param audio_tstamp_report Pointer to returned report */ void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj, snd_pcm_audio_tstamp_report_t *audio_tstamp_report) @@ -7036,7 +7036,7 @@ void snd_pcm_status_get_audio_htstamp_report(const snd_pcm_status_t *obj, /** * \brief set audio_tstamp_config from a PCM status container * \param obj pointer to #snd_pcm_status_t - * \param audio_tstamp_config Pointer to config (valid fields are type and report_analog_delay) + * \param audio_tstamp_config Pointer to config (valid fields are type_requested and report_delay) */ void snd_pcm_status_set_audio_htstamp_config(snd_pcm_status_t *obj, snd_pcm_audio_tstamp_config_t *audio_tstamp_config) diff --git a/src/pcm/pcm_meter.c b/src/pcm/pcm_meter.c index 18d921cc..68c369de 100644 --- a/src/pcm/pcm_meter.c +++ b/src/pcm/pcm_meter.c @@ -34,9 +34,11 @@ #include #include +#ifndef DOC_HIDDEN #define atomic_read(ptr) __atomic_load_n(ptr, __ATOMIC_SEQ_CST ) #define atomic_add(ptr, n) __atomic_add_fetch(ptr, n, __ATOMIC_SEQ_CST) #define atomic_dec(ptr) __atomic_sub_fetch(ptr, 1, __ATOMIC_SEQ_CST) +#endif #ifndef PIC /* entry for static linking */ diff --git a/src/pcm/pcm_route.c b/src/pcm/pcm_route.c index 94292fc7..38057cb2 100644 --- a/src/pcm/pcm_route.c +++ b/src/pcm/pcm_route.c @@ -765,7 +765,9 @@ static int strtochannel(const char *id, snd_pcm_chmap_t *chmap, } } +#ifndef DOC_HIDDEN #define MAX_CHMAP_CHANNELS 256 +#endif static int determine_chmap(snd_config_t *tt, snd_pcm_chmap_t **tt_chmap) { -- 2.47.1