mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doxygen: global: silence 'not documented' warnings

Browse source 
From: borine@github
Link: https://github.com/alsa-project/alsa-lib/pull/340
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
borine 2023-07-30 11:27:28 +01:00 • committed by Jaroslav Kysela
parent 382c700dfe
commit c4680ed458
4 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/global.h
View file

@ -128,9 +128,11 @@ int snd_async_handler_get_fd(snd_async_handler_t *handler);
int snd_async_handler_get_signo(snd_async_handler_t *handler); int snd_async_handler_get_signo(snd_async_handler_t *handler);
void *snd_async_handler_get_callback_private(snd_async_handler_t *handler); void *snd_async_handler_get_callback_private(snd_async_handler_t *handler);
#ifdef HAVE_SYS_SHM_H
struct snd_shm_area *snd_shm_area_create(int shmid, void *ptr); struct snd_shm_area *snd_shm_area_create(int shmid, void *ptr);
struct snd_shm_area *snd_shm_area_share(struct snd_shm_area *area); struct snd_shm_area *snd_shm_area_share(struct snd_shm_area *area);
int snd_shm_area_destroy(struct snd_shm_area *area); int snd_shm_area_destroy(struct snd_shm_area *area);
#endif
int snd_user_file(const char *file, char **result); int snd_user_file(const char *file, char **result);

2
src/async.c
View file

@ -29,7 +29,9 @@
#include <signal.h> #include <signal.h>
static struct sigaction previous_action; static struct sigaction previous_action;
#ifndef DOC_HIDDEN
#define MAX_SIG_FUNCTION_CODE 10 /* i.e. SIG_DFL SIG_IGN SIG_HOLD et al */ #define MAX_SIG_FUNCTION_CODE 10 /* i.e. SIG_DFL SIG_IGN SIG_HOLD et al */
#endif /* DOC_HIDDEN */
#ifdef SND_ASYNC_RT_SIGNAL #ifdef SND_ASYNC_RT_SIGNAL
/** async signal number */ /** async signal number */

2
src/dlmisc.c
View file

@ -170,8 +170,10 @@ EXPORT_SYMBOL void *INTERNAL(snd_dlopen_old)(const char *name, int mode)
} }
#endif #endif
#ifndef DOC_HIDDEN
use_symbol_version(__snd_dlopen_old, snd_dlopen, ALSA_0.9); use_symbol_version(__snd_dlopen_old, snd_dlopen, ALSA_0.9);
use_default_symbol_version(__snd_dlopen, snd_dlopen, ALSA_1.1.6); use_default_symbol_version(__snd_dlopen, snd_dlopen, ALSA_1.1.6);
#endif /* DOC_HIDDEN */
/** /**
* \brief Closes a dynamic library - ALSA wrapper for \c dlclose. * \brief Closes a dynamic library - ALSA wrapper for \c dlclose.

12
src/shmarea.c
View file

@ -18,6 +18,16 @@
* *
*/ */
/**
* \file shmarea.c
* \ingroup Global
* \brief shared memory helpers
* \author Jaroslav Kysela <perex@perex.cz>
* \date 2001
*
* Shared memory helpers
*/
#include "config.h" #include "config.h"
/* These funcs are only used by pcm_mmap when sys/shm.h is available. */ /* These funcs are only used by pcm_mmap when sys/shm.h is available. */
@ -102,6 +112,7 @@ int snd_shm_area_destroy(struct snd_shm_area *area)
return 0; return 0;
} }
#ifndef DOC_HIDDEN
void snd_shm_area_destructor(void) __attribute__ ((destructor)); void snd_shm_area_destructor(void) __attribute__ ((destructor));
void snd_shm_area_destructor(void) void snd_shm_area_destructor(void)
@ -114,5 +125,6 @@ void snd_shm_area_destructor(void)
shmdt(area->ptr); shmdt(area->ptr);
} }
} }
#endif /* DOC_HIDDEN */
#endif #endif