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
alsa-lib/doc/doxygen.cfg.in

143 lines
4.9 KiB
INI
Raw Normal View History

Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
PROJECT_NAME = "ALSA project - the C library reference"
OUTPUT_DIRECTORY = doxygen
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = @top_srcdir@/doc/index.doxygen \
@top_srcdir@/include/asoundlib.h \
@top_srcdir@/include/version.h \
@top_srcdir@/include/global.h \
@top_srcdir@/include/asoundef.h \
@top_srcdir@/include/input.h \
@top_srcdir@/include/output.h \
@top_srcdir@/include/error.h \
@top_srcdir@/include/conf.h \
@top_srcdir@/include/control.h \
@top_srcdir@/include/pcm.h \
@top_srcdir@/include/rawmidi.h \
@top_srcdir@/include/timer.h \
@top_srcdir@/include/hwdep.h \
@top_srcdir@/include/seq.h \
@top_srcdir@/include/seq_event.h \
@top_srcdir@/include/seqmid.h \
@top_srcdir@/include/seq_midi_event.h \
@top_srcdir@/include/pcm_external.h \
@top_srcdir@/include/pcm_extplug.h \
@top_srcdir@/include/pcm_ioplug.h \
@top_srcdir@/include/control_external.h \
@top_srcdir@/include/mixer.h \
ucm: build - add build support for Use Case Manager Add doxygen and make support for UCM. CC: Mark Brown <broonie@opensource.wolfsonmicro.com> Signed-off-by: Justin Xu <justinx@slimlogic.co.uk> Signed-off-by: Stefan Schmidt <stefan@slimlogic.co.uk> Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
2010-08-23 18:17:19 +02:00
@top_srcdir@/include/use-case.h \
topology: doxygen: Add doxygen support for topology core. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-07-29 17:45:24 +01:00
@top_srcdir@/include/topology.h \
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
@top_srcdir@/src/error.c \
@top_srcdir@/src/dlmisc.c \
@top_srcdir@/src/async.c \
@top_srcdir@/src/input.c \
@top_srcdir@/src/output.c \
@top_srcdir@/src/conf.c \
doxygen: conf: silence 'not documented' warnings From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-07-30 09:48:53 +01:00
@top_srcdir@/src/confeval.c \
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
@top_srcdir@/src/confmisc.c \
@top_srcdir@/src/names.c \
@top_srcdir@/src/shmarea.c \
@top_srcdir@/src/userfile.c \
control: doc - create controls plugin page Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-04-06 12:18:23 +02:00
@top_srcdir@/src/control/cards.c \
@top_srcdir@/src/control/control.c \
doxygen: include external control docs From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-07-29 14:45:22 +01:00
@top_srcdir@/src/control/control_ext.c \
control: doc - create controls plugin page Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-04-06 12:18:23 +02:00
@top_srcdir@/src/control/control_plugin.c \
@top_srcdir@/src/control/control_hw.c \
@top_srcdir@/src/control/control_remap.c \
@top_srcdir@/src/control/control_shm.c \
@top_srcdir@/src/control/ctlparse.c \
@top_srcdir@/src/control/hcontrol.c \
doxygen: namehint: silence 'not documented' warnings Also creates a new module within the Configuration interface documentation in which to present the name hint docs. From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-07-30 10:58:23 +01:00
@top_srcdir@/src/control/namehint.c \
control: doc - create controls plugin page Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2021-04-06 12:18:23 +02:00
@top_srcdir@/src/control/setup.c \
@top_srcdir@/src/control/tlv.c \
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
@top_srcdir@/src/mixer \
@top_srcdir@/src/pcm/pcm.c \
@top_srcdir@/src/pcm/pcm_mmap.c \
@top_srcdir@/src/pcm/pcm_plugin.c \
@top_srcdir@/src/pcm/pcm_hw.c \
@top_srcdir@/src/pcm/pcm_mmap_emul.c \
@top_srcdir@/src/pcm/pcm_shm.c \
@top_srcdir@/src/pcm/pcm_null.c \
@top_srcdir@/src/pcm/pcm_copy.c \
@top_srcdir@/src/pcm/pcm_linear.c \
@top_srcdir@/src/pcm/pcm_lfloat.c \
@top_srcdir@/src/pcm/pcm_mulaw.c \
@top_srcdir@/src/pcm/pcm_alaw.c \
@top_srcdir@/src/pcm/pcm_adpcm.c \
@top_srcdir@/src/pcm/pcm_route.c \
@top_srcdir@/src/pcm/pcm_rate.c \
@top_srcdir@/src/pcm/pcm_plug.c \
@top_srcdir@/src/pcm/pcm_file.c \
@top_srcdir@/src/pcm/pcm_multi.c \
@top_srcdir@/src/pcm/pcm_share.c \
@top_srcdir@/src/pcm/pcm_hooks.c \
@top_srcdir@/src/pcm/pcm_dmix.c \
@top_srcdir@/src/pcm/pcm_dshare.c \
@top_srcdir@/src/pcm/pcm_dsnoop.c \
@top_srcdir@/src/pcm/pcm_meter.c \
@top_srcdir@/src/pcm/pcm_ladspa.c \
@top_srcdir@/src/pcm/pcm_asym.c \
@top_srcdir@/src/pcm/pcm_iec958.c \
@top_srcdir@/src/pcm/pcm_softvol.c \
@top_srcdir@/src/pcm/pcm_extplug.c \
@top_srcdir@/src/pcm/pcm_ioplug.c \
@top_srcdir@/src/pcm/pcm_empty.c \
@top_srcdir@/src/pcm/pcm_misc.c \
@top_srcdir@/src/pcm/pcm_simple.c \
@top_srcdir@/src/rawmidi \
@top_srcdir@/src/timer \
@top_srcdir@/src/hwdep \
ucm: Moved ucm to src/ucm subdirectory - separate code to more files - use standard lists to represent structures - use alsa-lib configuration parser Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2010-09-07 15:35:14 +02:00
@top_srcdir@/src/seq \
topology: doxygen: Add doxygen support for topology core. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-07-29 17:45:24 +01:00
@top_srcdir@/src/ucm \
@top_srcdir@/src/topology
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
EXCLUDE = @top_srcdir@/src/control/control_local.h \
@top_srcdir@/src/pcm/atomic.h \
@top_srcdir@/src/pcm/interval.h \
@top_srcdir@/src/pcm/interval_inline.h \
@top_srcdir@/src/pcm/mask.h \
@top_srcdir@/src/pcm/mask_inline.h \
@top_srcdir@/src/pcm/pcm_local.h \
@top_srcdir@/src/pcm/pcm_meter.h \
@top_srcdir@/src/pcm/pcm_plugin.h \
@top_srcdir@/src/pcm/plugin_ops.h \
@top_srcdir@/src/pcm/ladspa.h \
@top_srcdir@/src/hwdep/hwdep_local.h \
@top_srcdir@/src/mixer/mixer_local.h \
@top_srcdir@/src/rawmidi/rawmidi_local.h \
ucm: Moved ucm to src/ucm subdirectory - separate code to more files - use standard lists to represent structures - use alsa-lib configuration parser Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2010-09-07 15:35:14 +02:00
@top_srcdir@/src/seq/seq_local.h \
topology: doxygen: Add doxygen support for topology core. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-07-29 17:45:24 +01:00
@top_srcdir@/src/ucm/ucm_local.h \
@top_srcdir@/src/topology/tplg_local.h
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
RECURSIVE = YES
FILE_PATTERNS = *.c *.h
doxygen: include docs for shmarea functions From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-08-02 14:40:29 +01:00
INCLUDE_PATH = @top_builddir@/include
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
EXAMPLE_PATH = @top_srcdir@/test
doxygen: fix image path From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-07-29 11:22:49 +01:00
IMAGE_PATH = @top_srcdir@/doc/pictures
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
QUIET = YES
EXTRACT_ALL = NO
EXTRACT_STATIC = NO
SHOW_INCLUDE_FILES = NO
JAVADOC_AUTOBRIEF = NO
INHERIT_DOCS = YES
ENABLED_SECTIONS = ""
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = DOXYGEN PIC "DOC_HIDDEN" \
"ATTRIBUTE_UNUSED=" \
ALSA_PCM_NEW_HW_PARAMS_API \
_POSIX_C_SOURCE \
"use_default_symbol_version(x,y,z)=" \
doxygen: seq: silence 'not documented' warnings From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela <perex@perex.cz>
2023-07-30 10:22:53 +01:00
"link_warning(x,y)=" \
__attribute__((x))=
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
OPTIMIZE_OUTPUT_FOR_C = YES # doxygen 1.2.6 option
doc: hide structs with typedefs In the documentation, hide structure types that have a corresponding typedef. Since doxygen 1.5.4, this is no longer the default when OPTIMIZE_OUTPUT_FOR_C is set. Signed-off-by: Clemens Ladisch <clemens@ladisch.de>
2009-08-04 09:15:40 +02:00
TYPEDEF_HIDES_STRUCT = YES # needed in doxygen >= 1.5.4
Create doxgen.cfg dynamically The patch from bug#3799 https://bugtrack.alsa-project.org/alsa-bug/view.php?id=3799 The "doc" target in doc/Makefile.am assumes the build directory and the source directory are the same and fails if they differ ... this is because the doxygen.cfg contains relative paths (such as ../) that only work when building in the source tree The attached patch against hg replaces all relative paths with @top_srcdir@ and changes doxygen.cfg to a generated file so that configure replaces @top_srcdir@ with the appropriate configure-time path. Assuming people like being able to do `make -f Makefile.am doc` on an unconfigured and having it work, i added a small `test&&sed` that'll generate an appropriate default doxygen.cfg for them.
2008-02-25 14:56:51 +01:00
#INPUT_FILTER = inputfilter
#FILTER_SOURCE_FILES = YES
doxygen: Suppress timestamp The build timestamp in the doc is bad for packaging in general, so let's disable it as default. Signed-off-by: Takashi Iwai <tiwai@suse.de>
2016-06-23 16:29:07 +02:00
HTML_TIMESTAMP = NO
Reference in a new issue Copy permalink