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

doxygen: fix for doxygen 1.10.0 and later

Browse source 
doygen 1.10.0 changed the paths that include files are searched, with
the consequence for alsa-lib that the "Topics" tab is no longer fully
populated.

To fix this we need to prevent circular #include references when doygen
scans its input files, and also to re-order some macros.
This commit is contained in:
borine 2025-11-01 08:34:51 +00:00
parent e6d0db9d0c
commit 1e5118536a
19 changed files with 89 additions and 97 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/doxygen.cfg.in
View file

@ -16,6 +16,7 @@ INPUT = @top_srcdir@/doc/index.doxygen \
@top_srcdir@/include/conf.h \ @top_srcdir@/include/conf.h \
@top_srcdir@/include/control.h \ @top_srcdir@/include/control.h \
@top_srcdir@/include/pcm.h \ @top_srcdir@/include/pcm.h \
@top_srcdir@/include/pcm_plugin.h \
@top_srcdir@/include/rawmidi.h \ @top_srcdir@/include/rawmidi.h \
@top_srcdir@/include/ump.h \ @top_srcdir@/include/ump.h \
@top_srcdir@/include/ump_msg.h \ @top_srcdir@/include/ump_msg.h \
@ -129,6 +130,7 @@ MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES EXPAND_ONLY_PREDEF = YES
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \ PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \
"ATTRIBUTE_UNUSED=" \ "ATTRIBUTE_UNUSED=" \
ALSA_LIBRARY_BUILD \
ALSA_PCM_NEW_HW_PARAMS_API \ ALSA_PCM_NEW_HW_PARAMS_API \
_POSIX_C_SOURCE \ _POSIX_C_SOURCE \
"use_default_symbol_version(x,y,z)=" \ "use_default_symbol_version(x,y,z)=" \
@ -137,7 +139,7 @@ PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \
OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option
TYPEDEF_HIDES_STRUCT = YES # needed in doxygen >= 1.5.4 TYPEDEF_HIDES_STRUCT = YES # needed in doxygen >= 1.5.4
SORT_GROUP_NAMES = YES
#INPUT_FILTER = inputfilter #INPUT_FILTER = inputfilter
#FILTER_SOURCE_FILES = YES #FILTER_SOURCE_FILES = YES

6
include/asoundef.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_ASOUNDEF_H
#define __ALSA_ASOUNDEF_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/asoundef.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/asoundef.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_ASOUNDEF_H
#define __ALSA_ASOUNDEF_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/conf.h
View file

@ -25,14 +25,14 @@
* *
*/ */
#ifndef __ALSA_CONF_H
#define __ALSA_CONF_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_CONF_H
#define __ALSA_CONF_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/control.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_CONTROL_H
#define __ALSA_CONTROL_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/control.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/control.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_CONTROL_H
#define __ALSA_CONTROL_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/error.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_ERROR_H
#define __ALSA_ERROR_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/error.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/error.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_ERROR_H
#define __ALSA_ERROR_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/global.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_GLOBAL_H_
#define __ALSA_GLOBAL_H_
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/global.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/global.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_GLOBAL_H_
#define __ALSA_GLOBAL_H_
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/hwdep.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_HWDEP_H
#define __ALSA_HWDEP_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/hwdep.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/hwdep.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_HWDEP_H
#define __ALSA_HWDEP_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/mixer.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_MIXER_H
#define __ALSA_MIXER_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/mixer.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/mixer.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_MIXER_H
#define __ALSA_MIXER_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/pcm.h
View file

@ -26,15 +26,15 @@
* *
*/ */
#ifndef __ALSA_PCM_H
#define __ALSA_PCM_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/pcm.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/pcm.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_PCM_H
#define __ALSA_PCM_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/pcm_extplug.h
View file

@ -28,14 +28,14 @@
* *
*/ */
#ifndef __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H
#if !defined(__ALSA_PCM_EXTERNAL_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ALSA_PCM_EXTERNAL_H) && !defined(ALSA_LIBRARY_BUILD)
#warning "use #include <alsa/pcm_external.h>, <alsa/pcm_extplug.h> should not be used directly" #warning "use #include <alsa/pcm_external.h>, <alsa/pcm_extplug.h> should not be used directly"
#include <alsa/pcm_external.h> #include <alsa/pcm_external.h>
#endif #endif
#ifndef __ALSA_PCM_EXTPLUG_H
#define __ALSA_PCM_EXTPLUG_H
/** /**
* \defgroup PCM_ExtPlug External Filter plugin SDK * \defgroup PCM_ExtPlug External Filter plugin SDK
* \ingroup Plugin_SDK * \ingroup Plugin_SDK

6
include/pcm_ioplug.h
View file

@ -28,14 +28,14 @@
* *
*/ */
#ifndef __ALSA_PCM_IOPLUG_H
#define __ALSA_PCM_IOPLUG_H
#if !defined(__ALSA_PCM_EXTERNAL_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ALSA_PCM_EXTERNAL_H) && !defined(ALSA_LIBRARY_BUILD)
#warning "use #include <alsa/pcm_external.h>, <alsa/pcm_ioplug.h> should not be used directly" #warning "use #include <alsa/pcm_external.h>, <alsa/pcm_ioplug.h> should not be used directly"
#include <alsa/pcm_external.h> #include <alsa/pcm_external.h>
#endif #endif
#ifndef __ALSA_PCM_IOPLUG_H
#define __ALSA_PCM_IOPLUG_H
/** /**
* \defgroup PCM_IOPlug External I/O plugin SDK * \defgroup PCM_IOPlug External I/O plugin SDK
* \ingroup Plugin_SDK * \ingroup Plugin_SDK

12
include/pcm_plugin.h
View file

@ -199,18 +199,6 @@ int _snd_pcm_ladspa_open(snd_pcm_t **pcmp, const char *name,
snd_config_t *root, snd_config_t *conf, snd_config_t *root, snd_config_t *conf,
snd_pcm_stream_t stream, int mode); snd_pcm_stream_t stream, int mode);
/*
* Jack plugin
*/
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);
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);
/** \} */ /** \} */
#endif /* __ALSA_PCM_PLUGIN_H */ #endif /* __ALSA_PCM_PLUGIN_H */

6
include/rawmidi.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_RAWMIDI_H
#define __ALSA_RAWMIDI_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/rawmidi.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/rawmidi.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_RAWMIDI_H
#define __ALSA_RAWMIDI_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/seq.h
View file

@ -26,15 +26,15 @@
* *
*/ */
#ifndef __ALSA_SEQ_H
#define __ALSA_SEQ_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/seq.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/seq.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_SEQ_H
#define __ALSA_SEQ_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/seq_event.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_SEQ_EVENT_H
#define __ALSA_SEQ_EVENT_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/seq_event.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/seq_event.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_SEQ_EVENT_H
#define __ALSA_SEQ_EVENT_H
/** /**
* \defgroup SeqEvents Sequencer Event Definitions * \defgroup SeqEvents Sequencer Event Definitions
* Sequencer Event Definitions * Sequencer Event Definitions

6
include/seqmid.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_SEQMID_H
#define __ALSA_SEQMID_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/seqmid.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/seqmid.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_SEQMID_H
#define __ALSA_SEQMID_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/timer.h
View file

@ -25,15 +25,15 @@
* *
*/ */
#ifndef __ALSA_TIMER_H
#define __ALSA_TIMER_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/timer.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/timer.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_TIMER_H
#define __ALSA_TIMER_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

6
include/ump.h
View file

@ -6,15 +6,15 @@
* API library for ALSA rawmidi/UMP interface * API library for ALSA rawmidi/UMP interface
*/ */
#ifndef __ALSA_UMP_H
#define __ALSA_UMP_H
#if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD) #if !defined(__ASOUNDLIB_H) && !defined(ALSA_LIBRARY_BUILD)
/* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */ /* don't use ALSA_LIBRARY_BUILD define in sources outside alsa-lib */
#warning "use #include <alsa/asoundlib.h>, <alsa/ump.h> should not be used directly" #warning "use #include <alsa/asoundlib.h>, <alsa/ump.h> should not be used directly"
#include <alsa/asoundlib.h> #include <alsa/asoundlib.h>
#endif #endif
#ifndef __ALSA_UMP_H
#define __ALSA_UMP_H
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif

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; return 0;
} }
#ifndef DOC_HIDDEN
#define hw_param_mask(params,var) \ #define hw_param_mask(params,var) \
&((params)->masks[(var) - SND_PCM_HW_PARAM_FIRST_MASK]) &((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) static int hw_params_call(snd_pcm_hw_t *pcm_hw, snd_pcm_hw_params_t *params)
{ {