mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2026-02-05 04:06:34 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doxygen: fix warnings and add missing ALSA_LIBRARY_BUILD define

Browse source 
BugLink: https://github.com/alsa-project/alsa-lib/pull/480
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2025-11-07 21:30:32 +01:00
parent b33d0e4ced
commit 2b6dedeb74
20 changed files with 50 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/doxygen.cfg.in
View file

@ -127,7 +127,7 @@ INHERIT_DOCS = YES
ENABLED_SECTIONS = ""
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" "ALSA_LIBRARY_BUILD" \
"ATTRIBUTE_UNUSED=" \
ALSA_PCM_NEW_HW_PARAMS_API \
_POSIX_C_SOURCE \
@ -140,5 +140,3 @@ TYPEDEF_HIDES_STRUCT = YES # needed in doxygen >= 1.5.4
#INPUT_FILTER = inputfilter
#FILTER_SOURCE_FILES = YES
HTML_TIMESTAMP = NO

2
include/asoundef.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_ASOUNDEF_H
#define __ALSA_ASOUNDEF_H
#define __ALSA_ASOUNDEF_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/conf.h
View file

@ -31,7 +31,7 @@
#endif
#ifndef __ALSA_CONF_H
#define __ALSA_CONF_H
#define __ALSA_CONF_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/control.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_CONTROL_H
#define __ALSA_CONTROL_H
#define __ALSA_CONTROL_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

6
include/error.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_ERROR_H
#define __ALSA_ERROR_H
#define __ALSA_ERROR_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {
@ -54,7 +54,7 @@ const char *snd_strerror(int errnum);
#define SND_LOG_INFO 3 /**< info priority level */
#define SND_LOG_DEBUG 4 /**< debug priority level */
#define SND_LOG_TRACE 5 /**< trace priority level */
#define SND_LOG_LAST SND_LOG_TRACE
#define SND_LOG_LAST SND_LOG_TRACE /**< last known value for priority level */
#define SND_ILOG_CORE 1 /**< core library code */
#define SND_ILOG_CONFIG 2 /**< configuration parsing and operations */
@ -68,7 +68,7 @@ const char *snd_strerror(int errnum);
#define SND_ILOG_UCM 10 /**< UCM API */
#define SND_ILOG_TOPOLOGY 11 /**< topology API */
#define SND_ILOG_ASERVER 12 /**< aserver */
#define SND_ILOG_LAST SND_ILOG_ASERVER
#define SND_ILOG_LAST SND_ILOG_ASERVER /**< last known value for interface */
/**
* \brief Log handler callback.

2
include/global.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_GLOBAL_H_
#define __ALSA_GLOBAL_H_
#define __ALSA_GLOBAL_H_ /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/hwdep.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_HWDEP_H
#define __ALSA_HWDEP_H
#define __ALSA_HWDEP_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/mixer.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_MIXER_H
#define __ALSA_MIXER_H
#define __ALSA_MIXER_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/pcm.h
View file

@ -33,7 +33,7 @@
#endif
#ifndef __ALSA_PCM_H
#define __ALSA_PCM_H
#define __ALSA_PCM_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/pcm_extplug.h
View file

@ -34,7 +34,7 @@
#endif
#ifndef __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H /**< header include loop protection */
/**
* \defgroup PCM_ExtPlug External Filter plugin SDK

2
include/pcm_ioplug.h
View file

@ -34,7 +34,7 @@
#endif
#ifndef __ALSA_PCM_IOPLUG_H
#define __ALSA_PCM_IOPLUG_H
#define __ALSA_PCM_IOPLUG_H /**< header include loop protection */
/**
* \defgroup PCM_IOPlug External I/O plugin SDK

24
include/pcm_plugin.h
View file

@ -202,10 +202,34 @@ int _snd_pcm_ladspa_open(snd_pcm_t **pcmp, const char *name,
/*
* Jack plugin
*/
/**
* \brief Creates a new Jack PCM
* \param pcmp Returns created PCM handle
* \param name Name of PCM
* \param playback_conf Playback configuration
* \param capture_conf Capture configuration
* \param stream Stream direction
* \param mode PCM open mode
* \retval zero on success otherwise a negative error code
* \warning alsa-lib must be compiled against the JACK library for this plugin to be available
*/
int snd_pcm_jack_open(snd_pcm_t **pcmp, const char *name,
snd_config_t *playback_conf,
snd_config_t *capture_conf,
snd_pcm_stream_t stream, int mode);
/**
* \brief Creates a new Jack PCM (internal)
* \param pcmp Returns created PCM handle
* \param name Name of PCM
* \param root Root configuration node
* \param conf Configuration for this PCM
* \param stream Stream direction
* \param mode PCM open mode
* \retval zero on success otherwise a negative error code
* \warning alsa-lib must be compiled against the JACK library for this plugin to be available
*/
int _snd_pcm_jack_open(snd_pcm_t **pcmp, const char *name,
snd_config_t *root, snd_config_t *conf,
snd_pcm_stream_t stream, int mode);

4
include/rawmidi.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_RAWMIDI_H
#define __ALSA_RAWMIDI_H
#define __ALSA_RAWMIDI_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {
@ -103,7 +103,7 @@ typedef enum _snd_rawmidi_read_mode {
#define SND_RAWMIDI_INFO_UMP 0x00000008 /**< rawmidi is UMP */
#define SND_RAWMIDI_INFO_STREAM_INACTIVE 0x00000010 /**< the selected substream is inactive */
#ifndef SNDRV_RAWMIDI_INFO_STREAM_INACTIVE
#define SNDRV_RAWMIDI_INFO_STREAM_INACTIVE SND_RAWMIDI_INFO_STREAM_INACTIVE /* only for compatibility */
#define SNDRV_RAWMIDI_INFO_STREAM_INACTIVE SND_RAWMIDI_INFO_STREAM_INACTIVE /**< compatibility alias for SND_RAWMIDI_INFO_STREAM_INACTIVE */
#endif
int snd_rawmidi_open(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,

2
include/seq.h
View file

@ -33,7 +33,7 @@
#endif
#ifndef __ALSA_SEQ_H
#define __ALSA_SEQ_H
#define __ALSA_SEQ_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/seq_event.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_SEQ_EVENT_H
#define __ALSA_SEQ_EVENT_H
#define __ALSA_SEQ_EVENT_H /**< header include loop protection */
/**
* \defgroup SeqEvents Sequencer Event Definitions

2
include/seqmid.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_SEQMID_H
#define __ALSA_SEQMID_H
#define __ALSA_SEQMID_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/timer.h
View file

@ -32,7 +32,7 @@
#endif
#ifndef __ALSA_TIMER_H
#define __ALSA_TIMER_H
#define __ALSA_TIMER_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

2
include/ump.h
View file

@ -13,7 +13,7 @@
#endif
#ifndef __ALSA_UMP_H
#define __ALSA_UMP_H
#define __ALSA_UMP_H /**< header include loop protection */
#ifdef __cplusplus
extern "C" {

4
src/error.c
View file

@ -419,7 +419,9 @@ snd_local_error_handler_t snd_lib_error_set_local(snd_local_error_handler_t func
local_error = func;
return old;
}
#ifndef DOC_HIDDEN
link_warning(snd_lib_error_set_local, "Warning: snd_lib_error_set_local is deprecated, use snd_lib_log_set_local");
#endif
/**
* \brief The default error handler function.
@ -448,7 +450,9 @@ static void snd_lib_error_default(const char *file, int line, const char *functi
* For internal use only.
*/
snd_lib_error_handler_t snd_lib_error = snd_lib_error_default;
#ifndef DOC_HIDDEN
link_warning(snd_lib_error, "Warning: snd_lib_error is deprecated, use snd_log interface");
#endif
/**
* \brief Sets the error handler.

2
src/pcm/pcm_hw.c
View file

@ -379,8 +379,10 @@ static int snd_pcm_hw_hw_refine(snd_pcm_t *pcm, snd_pcm_hw_params_t *params)
return 0;
}
#ifndef DOC_HIDDEN
#define hw_param_mask(params,var) \
&((params)->masks[(var) - SND_PCM_HW_PARAM_FIRST_MASK])
#endif
static int hw_params_call(snd_pcm_hw_t *pcm_hw, snd_pcm_hw_params_t *params)
{